summaryrefslogtreecommitdiff
path: root/data/zh_cn/governance/2021-01-20/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/governance/2021-01-20/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/governance/2021-01-20/api-docs.php')
-rw-r--r--data/zh_cn/governance/2021-01-20/api-docs.php3873
1 files changed, 1583 insertions, 2290 deletions
diff --git a/data/zh_cn/governance/2021-01-20/api-docs.php b/data/zh_cn/governance/2021-01-20/api-docs.php
index 658b366..1915a01 100644
--- a/data/zh_cn/governance/2021-01-20/api-docs.php
+++ b/data/zh_cn/governance/2021-01-20/api-docs.php
@@ -1,191 +1,186 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'governance',
- 'version' => '2021-01-20',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'governance', 'version' => '2021-01-20'],
'directories' => [
[
- 'id' => 366159,
- 'title' => '账号工厂',
+ 'children' => ['EnrollAccount', 'BatchEnrollAccounts', 'ListEnrolledAccounts', 'GetEnrolledAccount', 'GetAccountFactoryBaseline', 'ListAccountFactoryBaselines', 'CreateAccountFactoryBaseline', 'DeleteAccountFactoryBaseline', 'ListAccountFactoryBaselineItems', 'UpdateAccountFactoryBaseline'],
'type' => 'directory',
- 'children' => [
- 'EnrollAccount',
- 'BatchEnrollAccounts',
- 'ListEnrolledAccounts',
- 'GetEnrolledAccount',
- 'GetAccountFactoryBaseline',
- 'ListAccountFactoryBaselines',
- 'CreateAccountFactoryBaseline',
- 'DeleteAccountFactoryBaseline',
- 'ListAccountFactoryBaselineItems',
- 'UpdateAccountFactoryBaseline',
- ],
+ 'title' => '账号工厂',
+ 'id' => 45720,
],
[
- 'id' => 366170,
- 'title' => '治理成熟度检测',
+ 'children' => ['RunEvaluation', 'ListEvaluationMetadata', 'ListEvaluationScoreHistory', 'ListEvaluationMetricDetails', 'ListEvaluationResults', 'GenerateEvaluationReport'],
'type' => 'directory',
- 'children' => [
- 'RunEvaluation',
- 'ListEvaluationMetadata',
- 'ListEvaluationScoreHistory',
- 'ListEvaluationMetricDetails',
- 'ListEvaluationResults',
- 'GenerateEvaluationReport',
- ],
+ 'title' => '治理成熟度检测',
+ 'id' => 45731,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'EnrollAccount' => [
- 'summary' => '通过账号工厂创建一个新的资源账号或者纳管一个已有的资源账号。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchEnrollAccounts' => [
+ 'summary' => '批量为已有的资源账号应用账号基线。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceUXLQGP',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceUXLQGP'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AccountNamePrefix',
+ 'name' => 'Accounts',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'title' => '账号名称前缀',
- 'description' => '账号名称前缀。'."\n"
- ."\n"
- .'- 如果是新建资源账号，则该参数必填。'."\n"
- .'- 如果是注册应用到已有账号，则该参数不需要填写。',
- 'type' => 'string',
+ 'description' => '账号列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '账号信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountUid' => ['description' => '注册账号ID。该参数必填。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12868156179****'."\n"],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'test-account',
],
],
[
- 'name' => 'DisplayName',
+ 'name' => 'BaselineItems',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'title' => '账号显示名称',
- 'description' => '账号显示名称。'."\n"
+ 'description' => '基线项配置数组。'."\n"
."\n"
- .'- 如果是新建资源账号，则该参数必填。'."\n"
- .'- 如果是注册应用到已有账号，则该参数不需要填写。',
- 'type' => 'string',
+ .'如果传递了该参数，那么基线项的配置将和指定账号基线进行合并。相同的基线项将以该参数的配置为准。建议您将该参数置空，通过`BaselineId`参数指定账号基线，通过现有基线将配置应用到账号上。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '基线项配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Config' => ['description' => '基线项配置。', 'type' => 'string', 'required' => false, 'example' => '{"Notifications":[{"GroupKey":"account_msg","Contacts":[{"Name":"aa"}],"PmsgStatus":1,"EmailStatus":1,"SmsStatus":1}]}'],
+ 'Name' => ['description' => '基线项名称。', 'type' => 'string', 'required' => false, 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Skip' => ['description' => '是否跳过基线项。取值：'."\n"
+ ."\n"
+ .'- false：不跳过。'."\n"
+ .'- true：跳过。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'Version' => ['description' => '基线项版本。'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0'."\n"],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'test-account',
],
],
[
- 'name' => 'FolderId',
+ 'name' => 'BaselineId',
'in' => 'query',
- 'schema' => [
- 'title' => '父资源夹ID',
- 'description' => '父资源夹ID。'."\n"
- ."\n"
- .'- 如果是新建资源账号，该参数不填，则默认创建在Root资源夹下。'."\n"
- .'- 如果是注册应用到已有账号，则该参数不需要填写。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'fd-5ESoku****',
- ],
+ 'schema' => ['description' => '基线ID。'."\n"
+ ."\n"
+ .'置空则默认使用系统默认基线。', 'type' => 'string', 'required' => false, 'example' => 'afb-bp1durvn3lgqe28v****'],
],
[
- 'name' => 'PayerAccountUid',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '结算账号ID',
- 'description' => '结算账号ID。'."\n"
- ."\n"
- .'- 如果是新建资源账号，该参数不填，则默认为自主结算。'."\n"
- .'- 如果是注册应用到已有账号，则该参数不需要填写。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '19534534552****',
+ 'title' => 'ResponseBaseResult<Void>',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量注册账号',
+ 'description' => '通过该API，您可以在已有的资源账号上应用账号基线。'."\n"
+ ."\n"
+ .'注册账号是一个异步过程，创建完资源账号后，会在该账号上实施账号工厂基线。您可以通过[GetEnrolledAccount](~~609062~~)查询账号详情，获取实施结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchEnrollAccounts'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'AccountUid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '注册账号ID',
- 'description' => '注册账号ID。'."\n"
- ."\n"
- .'- 如果是新建资源账号，则该参数不需要填写。'."\n"
- .'- 如果是注册应用到已有账号，则该参数必填。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12868156179****',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'governance:BatchEnrollAccounts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1\\"\\n}","type":"json"}]',
+ ],
+ 'CreateAccountFactoryBaseline' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernance7SBZ97'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineName',
+ 'in' => 'query',
+ 'schema' => ['description' => '基线名称。', 'type' => 'string', 'required' => false, 'example' => 'Default', 'default' => 'Default'],
],
[
'name' => 'BaselineItems',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'title' => '基线项配置数组',
- 'description' => '基线项配置数组。'."\n"
+ 'description' => '基线项列表。'."\n"
."\n"
- .'如果传递了该参数，那么基线项的配置将和指定账号基线进行合并。相同的基线项将以该参数的配置为准。建议您将该参数置空，通过`BaselineId`参数指定账号基线，通过现有基线将配置应用到账号上。',
+ .'您可以调用[ListAccountFactoryBaselineItems](~~ListAccountFactoryBaselineItems~~)，获取云治理中心支持的账号工厂基线项列表。',
'type' => 'array',
'items' => [
'description' => '基线项配置。',
'type' => 'object',
'properties' => [
- 'Config' => [
- 'title' => '基线项配置',
- 'description' => '基线项配置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}',
- ],
- 'Name' => [
- 'title' => '基线项名称',
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Skip' => [
- 'title' => '是否跳过基线项',
- 'description' => '是否跳过基线项。取值：'."\n"
- ."\n"
- .'- false：不跳过。'."\n"
- .'- true：跳过。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'Version' => [
- 'title' => '基线项版本',
- 'description' => '基线项版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0',
- 'default' => '1.0',
- ],
+ 'Config' => ['description' => '基线项配置。格式为JSON字符串。', 'type' => 'string', 'required' => false, 'example' => '{"EnabledServices":["CEN_TR","CDT","CMS","KMS"]}'],
+ 'Name' => ['description' => '基线项名称。', 'type' => 'string', 'required' => false, 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Version' => ['description' => '基线项版本。', 'type' => 'string', 'required' => false, 'example' => '1.0', 'default' => '1.0'],
],
'required' => false,
],
@@ -193,219 +188,194 @@
],
],
[
- 'name' => 'BaselineId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '基线ID',
- 'description' => '基线ID。'."\n"
- ."\n"
- .'置空则默认使用系统默认基线。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'afb-bp1durvn3lgqe28v****',
- ],
+ 'schema' => ['description' => '基线描述。', 'type' => 'string', 'required' => false, 'example' => 'Default Baseline.'],
],
[
- 'name' => 'ResellAccountType',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '账号身份类型',
- 'description' => '成员的身份类型。取值：'."\n"
- ."\n"
- .'- resell（默认值）：分销账号。创建的成员将自动与您的分销商建立分销关系，同时您需要使用管理账号为新成员付款。'."\n"
- .'- non_resell：非分销账号。创建的成员为阿里云普通账号，与您当前的分销商无关联关系，该账号直接从阿里云购买资源，需自主付款。'."\n"
- ."\n"
- .'> '."\n"
- .'> 该参数仅支持国际站分销客户。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'resell',
+ 'title' => 'ResponseBaseResult<CreateAccountFactoryBaselineResponse>',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BaselineId' => ['description' => '基线ID。', 'type' => 'string', 'example' => 'afb-bp1e6ixtiwupap8m****'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A5592E2E-0FC4-557C-B989-DF229B5EBE13'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建账号工厂基线',
+ 'summary' => '创建账号工厂基线。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccountFactoryBaseline'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'governance:CreateAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BaselineId\\": \\"afb-bp1e6ixtiwupap8m****\\",\\n \\"RequestId\\": \\"A5592E2E-0FC4-557C-B989-DF229B5EBE13\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteAccountFactoryBaseline' => [
+ 'summary' => '删除账号工厂基线。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
[
- 'name' => 'Tag',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '标签列表，最多包含20个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签列表。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tagKey',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tagValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '基线ID。', 'type' => 'string', 'required' => false, 'example' => 'afb-bp1durvn3lgqe28v****'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ResponseBaseResult<EnrollAccountResponse>',
- 'description' => '返回参数。',
+ 'title' => 'ResponseBaseResult<Void>',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'AccountUid' => [
- 'title' => '注册账号ID',
- 'description' => '注册账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '143165363236****',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7071E5FA-515E-5F53-B335-B87D619C6A66',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '0F45D888-8C4D-55E5-ACA2-D1515159181D'],
],
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is not valid.',
- ],
- [
- 'errorCode' => 'DeployConflict.Blueprint',
- 'errorMessage' => 'The %s blueprint is being deployed. Please wait for its deployment to complete and try again.',
- ],
- [
- 'errorCode' => 'DependencyViolation.Blueprint',
- 'errorMessage' => 'The %s blueprint has not been deployed. Please deploy the resource structure first.',
- ],
- [
- 'errorCode' => 'DependencyViolation.BaselineItem',
- 'errorMessage' => 'The dependency of %s baseline item has not been configured. Please config %s first.',
- ],
- [
- 'errorCode' => 'IncorrectBlueprintStatus',
- 'errorMessage' => 'The current status of the blueprint does not support this operation.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
- 403 => [
- [
- 'errorCode' => 'InvalidUser.NotResourceDirectoryMaster',
- 'errorMessage' => 'The specified account is not a master account of resource directory.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
- [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user does not exist.',
- ],
- [
- 'errorCode' => 'InvalidBlueprint.NotFound',
- 'errorMessage' => 'The specified blueprint does not exist.',
- ],
- [
- 'errorCode' => 'InvalidBaselineItem.NotFound',
- 'errorMessage' => 'The specified baseline item named %s does not exist.',
- ],
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除账号工厂基线',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccountFactoryBaseline'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'governance:DeleteAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountUid\\": 0,\\n \\"RequestId\\": \\"7071E5FA-515E-5F53-B335-B87D619C6A66\\"\\n}","type":"json"}]',
- 'title' => '注册账号',
- 'description' => '通过该API，您可以创建一个新的资源账号或者纳管一个已有的资源账号，并在该账号上应用账号基线。'."\n"
- ."\n"
- .'注册账号是一个异步过程，创建完资源账号后，会在该账号上实施账号工厂基线。您可以通过[GetEnrolledAccount](~~GetEnrolledAccount~~)查询账号详情，获取实施结果。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F45D888-8C4D-55E5-ACA2-D1515159181D\\"\\n}","type":"json"}]',
],
- 'BatchEnrollAccounts' => [
- 'summary' => '批量为已有的资源账号应用账号基线。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'EnrollAccount' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceUXLQGP',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceUXLQGP'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Accounts',
+ 'name' => 'AccountNamePrefix',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '账号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '账号信息。',
- 'type' => 'object',
- 'properties' => [
- 'AccountUid' => [
- 'description' => '注册账号ID。该参数必填。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12868156179****'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '账号名称前缀', 'description' => '账号名称前缀。'."\n"
+ ."\n"
+ .'- 如果是新建资源账号，则该参数必填。'."\n"
+ .'- 如果是注册应用到已有账号，则该参数不需要填写。', 'type' => 'string', 'required' => false, 'example' => 'test-account'],
+ ],
+ [
+ 'name' => 'DisplayName',
+ 'in' => 'query',
+ 'schema' => ['title' => '账号显示名称', 'description' => '账号显示名称。'."\n"
+ ."\n"
+ .'- 如果是新建资源账号，则该参数必填。'."\n"
+ .'- 如果是注册应用到已有账号，则该参数不需要填写。', 'type' => 'string', 'required' => false, 'example' => 'test-account'],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'query',
+ 'schema' => ['title' => '父资源夹ID', 'description' => '父资源夹ID。'."\n"
+ ."\n"
+ .'- 如果是新建资源账号，该参数不填，则默认创建在Root资源夹下。'."\n"
+ .'- 如果是注册应用到已有账号，则该参数不需要填写。', 'type' => 'string', 'required' => false, 'example' => 'fd-5ESoku****'],
+ ],
+ [
+ 'name' => 'PayerAccountUid',
+ 'in' => 'query',
+ 'schema' => ['title' => '结算账号ID', 'description' => '结算账号ID。'."\n"
+ ."\n"
+ .'- 如果是新建资源账号，该参数不填，则默认为自主结算。'."\n"
+ .'- 如果是注册应用到已有账号，则该参数不需要填写。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '19534534552****'],
+ ],
+ [
+ 'name' => 'AccountUid',
+ 'in' => 'query',
+ 'schema' => ['title' => '注册账号ID', 'description' => '注册账号ID。'."\n"
+ ."\n"
+ .'- 如果是新建资源账号，则该参数不需要填写。'."\n"
+ .'- 如果是注册应用到已有账号，则该参数必填。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12868156179****'],
],
[
'name' => 'BaselineItems',
'in' => 'query',
'style' => 'flat',
'schema' => [
+ 'title' => '基线项配置数组',
'description' => '基线项配置数组。'."\n"
."\n"
.'如果传递了该参数，那么基线项的配置将和指定账号基线进行合并。相同的基线项将以该参数的配置为准。建议您将该参数置空，通过`BaselineId`参数指定账号基线，通过现有基线将配置应用到账号上。',
@@ -414,33 +384,13 @@
'description' => '基线项配置。',
'type' => 'object',
'properties' => [
- 'Config' => [
- 'description' => '基线项配置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"Notifications":[{"GroupKey":"account_msg","Contacts":[{"Name":"aa"}],"PmsgStatus":1,"EmailStatus":1,"SmsStatus":1}]}',
- ],
- 'Name' => [
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Skip' => [
- 'description' => '是否跳过基线项。取值：'."\n"
- ."\n"
- .'- false：不跳过。'."\n"
- .'- true：跳过。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'Version' => [
- 'description' => '基线项版本。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0'."\n",
- ],
+ 'Config' => ['title' => '基线项配置', 'description' => '基线项配置。', 'type' => 'string', 'required' => false, 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}'],
+ 'Name' => ['title' => '基线项名称', 'description' => '基线项名称。', 'type' => 'string', 'required' => false, 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Skip' => ['title' => '是否跳过基线项', 'description' => '是否跳过基线项。取值：'."\n"
+ ."\n"
+ .'- false：不跳过。'."\n"
+ .'- true：跳过。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'Version' => ['title' => '基线项版本', 'description' => '基线项版本。', 'type' => 'string', 'required' => false, 'example' => '1.0', 'default' => '1.0'],
],
'required' => false,
],
@@ -450,270 +400,325 @@
[
'name' => 'BaselineId',
'in' => 'query',
- 'schema' => [
- 'description' => '基线ID。'."\n"
- ."\n"
- .'置空则默认使用系统默认基线。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'afb-bp1durvn3lgqe28v****',
- ],
+ 'schema' => ['title' => '基线ID', 'description' => '基线ID。'."\n"
+ ."\n"
+ .'置空则默认使用系统默认基线。', 'type' => 'string', 'required' => false, 'example' => 'afb-bp1durvn3lgqe28v****'],
+ ],
+ [
+ 'name' => 'ResellAccountType',
+ 'in' => 'query',
+ 'schema' => ['title' => '账号身份类型', 'description' => '成员的身份类型。取值：'."\n"
+ ."\n"
+ .'- resell（默认值）：分销账号。创建的成员将自动与您的分销商建立分销关系，同时您需要使用管理账号为新成员付款。'."\n"
+ .'- non_resell：非分销账号。创建的成员为阿里云普通账号，与您当前的分销商无关联关系，该账号直接从阿里云购买资源，需自主付款。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> 该参数仅支持国际站分销客户。', 'type' => 'string', 'required' => false, 'example' => 'resell'],
],
[
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
+ 'description' => '标签列表，最多包含20个子项。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'tagKey'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'tagValue'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ResponseBaseResult<Void>',
+ 'title' => 'ResponseBaseResult<EnrollAccountResponse>',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1',
- ],
+ 'AccountUid' => ['title' => '注册账号ID', 'description' => '注册账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '143165363236****'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '7071E5FA-515E-5F53-B335-B87D619C6A66'],
],
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '您的请求中存在参数缺失或者参数无效。'],
+ ['errorCode' => 'DeployConflict.Blueprint', 'errorMessage' => 'The %s blueprint is being deployed. Please wait for its deployment to complete and try again.', 'description' => '您有正在实施的蓝图，请等待其实施完成后重试。'],
+ ['errorCode' => 'DependencyViolation.Blueprint', 'errorMessage' => 'The %s blueprint has not been deployed. Please deploy the resource structure first.', 'description' => '您还没有实施相关依赖的蓝图，请先完成依赖蓝图的实施。'],
+ ['errorCode' => 'DependencyViolation.BaselineItem', 'errorMessage' => 'The dependency of %s baseline item has not been configured. Please config %s first.', 'description' => '您还没有配置相关依赖的基线项，请先完成依赖基线项的配置。'],
+ ['errorCode' => 'IncorrectBlueprintStatus', 'errorMessage' => 'The current status of the blueprint does not support this operation.', 'description' => '蓝图当前状态不支持该操作，请稍后重试。'],
+ ],
+ 403 => [
+ ['errorCode' => 'InvalidUser.NotResourceDirectoryMaster', 'errorMessage' => 'The specified account is not a master account of resource directory.', 'description' => '当前账号必须是资源目录的管理账号。'],
+ ],
+ [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user does not exist.', 'description' => '用户不存在。'],
+ ['errorCode' => 'InvalidBlueprint.NotFound', 'errorMessage' => 'The specified blueprint does not exist.', 'description' => '蓝图实例不存在。'],
+ ['errorCode' => 'InvalidBaselineItem.NotFound', 'errorMessage' => 'The specified baseline item named %s does not exist.', 'description' => '指定的基线项不存在。'],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1\\"\\n}","type":"json"}]',
- 'title' => '批量注册账号',
- 'description' => '通过该API，您可以在已有的资源账号上应用账号基线。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '注册账号',
+ 'summary' => '通过账号工厂创建一个新的资源账号或者纳管一个已有的资源账号。',
+ 'description' => '通过该API，您可以创建一个新的资源账号或者纳管一个已有的资源账号，并在该账号上应用账号基线。'."\n"
."\n"
- .'注册账号是一个异步过程，创建完资源账号后，会在该账号上实施账号工厂基线。您可以通过[GetEnrolledAccount](~~609062~~)查询账号详情，获取实施结果。',
- ],
- 'ListEnrolledAccounts' => [
- 'summary' => '获取账号工厂中注册账号的列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'注册账号是一个异步过程，创建完资源账号后，会在该账号上实施账号工厂基线。您可以通过[GetEnrolledAccount](~~GetEnrolledAccount~~)查询账号详情，获取实施结果。',
+ 'changeSet' => [
+ ['createdAt' => '2024-10-12T08:23:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-19T07:42:33.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
+ ['createdAt' => '2023-03-15T03:16:10.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-07-21T09:00:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-18T08:19:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnrollAccount'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'governance:EnrollAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountUid\\": 0,\\n \\"RequestId\\": \\"7071E5FA-515E-5F53-B335-B87D619C6A66\\"\\n}","type":"json"}]',
+ ],
+ 'GenerateEvaluationReport' => [
+ 'summary' => '生成治理检测报告',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceARZHCM',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernance9GNJ07'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'NextToken',
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'AccountId',
+ 'in' => 'query',
+ 'schema' => ['description' => '账号ID，若不传入，默认生成当前账号的报告，MA账号可以传入成员账号的ID生成成员账号的报告。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '103144549568****'],
+ ],
+ [
+ 'name' => 'ReportType',
'in' => 'query',
'schema' => [
- 'title' => '查询返回结果下一页的令牌。首次调用API不需要NextToken',
- 'description' => '查询返回结果下一页的令牌。'."\n"
- ."\n"
- .'首次调用API不需要NextToken。',
+ 'description' => '报告类型。取值类型：'."\n"
+ .'- EvaluationAccountHtmlReport：单账号HTML报告。'."\n"
+ .'- EvaluationAccountExcelReport：单账号EXCEL报告。'."\n"
+ .'- EvaluationMultiAccountExcelReport：多账号EXCEL报告。',
'type' => 'string',
'required' => false,
- 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****',
+ 'example' => 'EvaluationAccountExcelReport',
+ 'enum' => ['EvaluationAccountReport', 'EvaluationAccountExcelReport', 'EvaluationMultiAccountExcelReport', 'EvaluationAccountHtmlReport'],
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'AccountIds',
'in' => 'query',
- 'allowEmptyValue' => false,
+ 'style' => 'json',
'schema' => [
- 'title' => '每页的最大数据条数',
- 'description' => '每页的最大数据条数。'."\n"
- ."\n"
- .'取值范围：1~100。默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '生成报告的成员账号ID列表。'."\n"
+ .'说明：仅在您生成多账号报告时，且希望生成指定账号范围的报告，才需要传入该参数。',
+ 'type' => 'array',
+ 'items' => ['description' => '账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1319994761488600'],
'required' => false,
- 'maximum' => '100',
- 'exclusiveMaximum' => false,
- 'minimum' => '1',
- 'exclusiveMinimum' => false,
- 'example' => '10',
- 'default' => '10',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'EvaluationDomain',
'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountId' => ['description' => '生成报告的账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '103144549568****'],
+ 'EvaluationScore' => ['description' => '治理成熟度检测分数。', 'type' => 'number', 'format' => 'double', 'example' => '0.7684'],
+ 'EvaluationTime' => ['description' => '检测时间。', 'type' => 'string', 'example' => '2026-01-12T07:25:33Z'],
+ 'Finished' => ['description' => '报告是否生成完毕。'."\n"
+ ."\n"
+ .'> - true：报告生成完毕'."\n"
+ .'> - false：报告未生成完毕', 'type' => 'string', 'example' => 'true'],
+ 'ReportType' => ['description' => '报告类型。返回值类型：'."\n"
+ .'- EvaluationAccountHtmlReport：单账号HTML报告。'."\n"
+ .'- EvaluationAccountExcelReport：单账号EXCEL报告。'."\n"
+ .'- EvaluationMultiAccountExcelReport：多账号EXCEL报告。', 'type' => 'string', 'example' => 'EvaluationAccountExcelReport'],
+ 'ReportUrl' => ['description' => '报告的下载地址。', 'type' => 'string', 'example' => 'https://governance-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/reports-html/*****'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7DCF863F-CBBB-57C4-8AF2-5D4EE35D1EB1'],
+ ],
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成治理检测报告',
+ 'description' => '生成治理检测报告'."\n"
+ .'> '."\n"
+ .'> - 该接口为异步接口，通过返回值`Finished`字段判断报告生成情况。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'governance:GenerateEvaluationReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountId\\": 0,\\n \\"EvaluationScore\\": 0.7684,\\n \\"EvaluationTime\\": \\"2026-01-12T07:25:33Z\\",\\n \\"Finished\\": \\"true\\",\\n \\"ReportType\\": \\"EvaluationAccountExcelReport\\",\\n \\"ReportUrl\\": \\"https://governance-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/reports-html/*****\\",\\n \\"RequestId\\": \\"7DCF863F-CBBB-57C4-8AF2-5D4EE35D1EB1\\"\\n}","type":"json"}]',
+ ],
+ 'GetAccountFactoryBaseline' => [
+ 'summary' => '获取账号工厂基线详情。',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'query',
+ 'schema' => ['description' => '基线ID。', 'type' => 'string', 'required' => false, 'example' => 'afb-bp1nf0enuzb89az*****'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => '注册账号列表',
- 'description' => '注册账号列表。',
+ 'title' => 'ResponseBaseResult<GetAccountFactoryBaselineResponse>',
+ 'description' => '基线配置。',
'type' => 'object',
'properties' => [
- 'EnrolledAccounts' => [
- 'title' => '账号列表',
- 'description' => '账号列表。',
+ 'BaselineId' => ['description' => '基线ID。', 'type' => 'string', 'example' => 'afb-bp16ae2k8a3yo3d*****'],
+ 'BaselineItems' => [
+ 'description' => '基线项列表。',
'type' => 'array',
'items' => [
- 'description' => '账号。',
+ 'description' => '基线项配置。',
'type' => 'object',
'properties' => [
- 'AccountUid' => [
- 'title' => '账号ID',
- 'description' => '账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '19534534552*****',
- ],
- 'BaselineId' => [
- 'description' => '当前应用的基线ID。',
- 'type' => 'string',
- 'example' => 'afb-bp1durvn3lgqe28v****',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2021-11-01T02:38:27Z',
- ],
- 'DisplayName' => [
- 'title' => '账号显示名称',
- 'description' => '账号显示名称。',
- 'type' => 'string',
- 'example' => 'TestAccount',
- ],
- 'FolderId' => [
- 'title' => '父资源夹ID',
- 'description' => '父资源夹ID。',
- 'type' => 'string',
- 'example' => 'fd-5ESoku****',
- ],
- 'PayerAccountUid' => [
- 'title' => '结算账号ID',
- 'description' => '结算账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13161210500*****',
- ],
- 'Status' => [
- 'title' => '创建状态',
- 'description' => '创建状态。取值：'."\n"
- ."\n"
- .'- Pending：等待中。'."\n"
- .'- Running：创建实施中。'."\n"
- .'- Finished：创建成功。'."\n"
- .'- Failed：创建失败。'."\n"
- .'- Scheduling：调度中。'."\n"
- .'- ScheduleFailed：调度失败。',
- 'type' => 'string',
- 'example' => 'Running',
- 'enum' => [],
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间。',
- 'type' => 'string',
- 'example' => '2021-11-01T02:38:27Z',
- ],
+ 'Config' => ['description' => '基线项的配置。'."\n"
+ ."\n"
+ .'格式为JSON字符串。', 'type' => 'string', 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}'],
+ 'Name' => ['description' => '基线项的名称。', 'type' => 'string', 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Version' => ['description' => '基线项的版本。', 'type' => 'string', 'example' => '1.0'],
],
],
],
- 'NextToken' => [
- 'title' => '查询返回结果下一页的令牌',
- 'description' => '查询返回结果下一页的令牌。',
- 'type' => 'string',
- 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '768F908D-A66A-5A5D-816C-20C93CBBFEE3',
- ],
+ 'BaselineName' => ['description' => '基线名称。', 'type' => 'string', 'example' => 'Default', 'default' => 'Default'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-11-28T00:46:34Z'],
+ 'Description' => ['description' => '基线描述。', 'type' => 'string', 'example' => 'Default baseline'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '60D54503-F1F6-51B6-B6FA-A70CBDA2A68C'],
+ 'Type' => ['description' => '基线类型。取值：'."\n"
+ .'- System：系统默认基线。'."\n"
+ .'- Custom：用户自定义基线。', 'type' => 'string', 'example' => 'Custom'],
+ 'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2022-11-02T01:00:07Z'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is not valid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '您的请求中存在参数缺失或者参数无效。'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user does not exist.',
- ],
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user does not exist.', 'description' => '用户不存在。'],
+ ['errorCode' => 'InvalidBaseline.NotFound', 'errorMessage' => 'The specified baseline does not exist.', 'description' => '指定的账号基线不存在。'],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BaselineId\\": \\"afb-bp16ae2k8a3yo3d*****\\",\\n \\"BaselineItems\\": [\\n {\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"Notifications\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"GroupKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"account_msg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Contacts\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aa\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"PmsgStatus\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"EmailStatus\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"SmsStatus\\\\\\\\\\\\\\":1}]}\\",\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"BaselineName\\": \\"Default\\",\\n \\"CreateTime\\": \\"2022-11-28T00:46:34Z\\",\\n \\"Description\\": \\"Default baseline\\",\\n \\"RequestId\\": \\"60D54503-F1F6-51B6-B6FA-A70CBDA2A68C\\",\\n \\"Type\\": \\"Custom\\",\\n \\"UpdateTime\\": \\"2022-11-02T01:00:07Z\\"\\n}","type":"json"}]',
+ 'title' => '获取账号工厂基线详情',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T07:42:33.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnrolledAccounts\\": [\\n {\\n \\"AccountUid\\": 0,\\n \\"BaselineId\\": \\"afb-bp1durvn3lgqe28v****\\",\\n \\"CreateTime\\": \\"2021-11-01T02:38:27Z\\",\\n \\"DisplayName\\": \\"TestAccount\\",\\n \\"FolderId\\": \\"fd-5ESoku****\\",\\n \\"PayerAccountUid\\": 0,\\n \\"Status\\": \\"Running\\",\\n \\"UpdateTime\\": \\"2021-11-01T02:38:27Z\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****\\",\\n \\"RequestId\\": \\"768F908D-A66A-5A5D-816C-20C93CBBFEE3\\"\\n}","errorExample":""},{"type":"xml","example":"<ListEnrolledAccountsResponse>\\n <RequestId>768F908D-A66A-5A5D-816C-20C93CBBFEE3</RequestId>\\n <NextToken>AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****</NextToken>\\n <EnrolledAccounts>\\n <Status>Running</Status>\\n <CreateTime>2021-11-01T02:38:27Z</CreateTime>\\n <DisplayName>TestAccount</DisplayName>\\n <FolderId>fd-5ESoku****</FolderId>\\n <UpdateTime>2021-11-01T02:38:27Z</UpdateTime>\\n <AccountUid>1234</AccountUid>\\n <PayerAccountUid>1234</PayerAccountUid>\\n </EnrolledAccounts>\\n</ListEnrolledAccountsResponse>","errorExample":""}]',
- 'title' => '获取账号工厂中注册账号的列表',
- ],
- 'GetEnrolledAccount' => [
- 'summary' => '获取账号工厂中注册账号详情。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountFactoryBaseline'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:GetAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ ],
+ 'GetEnrolledAccount' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -721,34 +726,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AccountUid',
'in' => 'query',
- 'schema' => [
- 'title' => '账号ID',
- 'description' => '账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '19534534552****',
- ],
+ 'schema' => ['title' => '账号ID', 'description' => '账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19534534552****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
@@ -758,19 +746,8 @@
'description' => '注册账号信息。',
'type' => 'object',
'properties' => [
- 'AccountUid' => [
- 'title' => '账号ID',
- 'description' => '账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12868156179*****',
- ],
- 'BaselineId' => [
- 'title' => '基线ID',
- 'description' => '当前应用的基线ID。',
- 'type' => 'string',
- 'example' => 'afb-bp1adadfadsf***',
- ],
+ 'AccountUid' => ['title' => '账号ID', 'description' => '账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12868156179*****'],
+ 'BaselineId' => ['title' => '基线ID', 'description' => '当前应用的基线ID。', 'type' => 'string', 'example' => 'afb-bp1adadfadsf***'],
'BaselineItems' => [
'description' => '基线项配置数组。',
'type' => 'array',
@@ -778,44 +755,18 @@
'description' => '基线项配置。',
'type' => 'object',
'properties' => [
- 'Config' => [
- 'description' => '基线项配置。',
- 'type' => 'string',
- 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}',
- ],
- 'Name' => [
- 'description' => '基线项的名称。',
- 'type' => 'string',
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Skip' => [
- 'description' => '是否跳过基线项。取值：'."\n"
- ."\n"
- .'- false：不跳过。'."\n"
- .'- true：跳过。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Version' => [
- 'description' => '基线项版本。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
+ 'Config' => ['description' => '基线项配置。', 'type' => 'string', 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}'],
+ 'Name' => ['description' => '基线项的名称。', 'type' => 'string', 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Skip' => ['description' => '是否跳过基线项。取值：'."\n"
+ ."\n"
+ .'- false：不跳过。'."\n"
+ .'- true：跳过。', 'type' => 'boolean', 'example' => 'false'],
+ 'Version' => ['description' => '基线项版本。', 'type' => 'string', 'example' => '1.0'],
],
],
],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2021-11-01T02:38:27Z',
- ],
- 'DisplayName' => [
- 'title' => '账号显示名称',
- 'description' => '账号显示名称。',
- 'type' => 'string',
- 'example' => 'test-account',
- ],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-11-01T02:38:27Z'],
+ 'DisplayName' => ['title' => '账号显示名称', 'description' => '账号显示名称。', 'type' => 'string', 'example' => 'test-account'],
'ErrorInfo' => [
'title' => '错误信息',
'description' => '错误信息。'."\n"
@@ -823,65 +774,24 @@
.'> 当`Status`为`Failed`或`ScheduleFailed`时，返回该错误信息。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'EntityAlreadyExists.Role',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'The role already exists.',
- ],
- 'Recommend' => [
- 'title' => '错误处理建议',
- 'description' => '处理建议。',
- 'type' => 'string',
- 'example' => 'https://next.api.aliyun.com/troubleshoot?q=EntityAlreadyExists.Role\\u0026product=Ram',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E',
- ],
+ 'Code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'EntityAlreadyExists.Role'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The role already exists.'],
+ 'Recommend' => ['title' => '错误处理建议', 'description' => '处理建议。', 'type' => 'string', 'example' => 'https://next.api.aliyun.com/troubleshoot?q=EntityAlreadyExists.Role\\u0026product=Ram'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E'],
],
],
- 'FolderId' => [
- 'title' => '父资源夹ID',
- 'description' => '父资源夹ID。',
- 'type' => 'string',
- 'example' => 'fd-5ESoku****',
- ],
- 'Initialized' => [
- 'title' => '是否初始化完成',
- 'description' => '是否初始化完成。取值：'."\n"
- ."\n"
- .'- false：未完成。'."\n"
- .'- true：已完成。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'FolderId' => ['title' => '父资源夹ID', 'description' => '父资源夹ID。', 'type' => 'string', 'example' => 'fd-5ESoku****'],
+ 'Initialized' => ['title' => '是否初始化完成', 'description' => '是否初始化完成。取值：'."\n"
+ ."\n"
+ .'- false：未完成。'."\n"
+ .'- true：已完成。', 'type' => 'boolean', 'example' => 'true'],
'Inputs' => [
'title' => '注册账号时的输入参数',
'description' => '注册账号时的输入参数。',
'type' => 'object',
'properties' => [
- 'AccountNamePrefix' => [
- 'title' => '账号名称前缀',
- 'description' => '账号名称前缀。',
- 'type' => 'string',
- 'example' => 'test-account',
- ],
- 'AccountUid' => [
- 'title' => '账号ID',
- 'description' => '账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12868156179*****',
- ],
+ 'AccountNamePrefix' => ['title' => '账号名称前缀', 'description' => '账号名称前缀。', 'type' => 'string', 'example' => 'test-account'],
+ 'AccountUid' => ['title' => '账号ID', 'description' => '账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12868156179*****'],
'BaselineItems' => [
'title' => '基线项配置数组',
'description' => '基线项列表。',
@@ -890,55 +800,19 @@
'description' => '基线项列表。',
'type' => 'object',
'properties' => [
- 'Config' => [
- 'title' => '基线项配置',
- 'description' => '基线项配置。',
- 'type' => 'string',
- 'example' => '{\\"Contacts\\":[{\\"Name\\":\\"governance\\",\\"Email\\":\\"wibud5210+10@gmail.com\\",\\"Mobile\\":\\"1234\\",\\"Position\\":\\"Other\\"}]}',
- ],
- 'Name' => [
- 'title' => '基线项名称',
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Skip' => [
- 'title' => '是否跳过基线项',
- 'description' => '是否跳过基线项。取值：'."\n"
- ."\n"
- .'- false：不跳过。'."\n"
- .'- true：跳过。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Version' => [
- 'title' => '基线项版本',
- 'description' => '基线项版本。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
+ 'Config' => ['title' => '基线项配置', 'description' => '基线项配置。', 'type' => 'string', 'example' => '{\\"Contacts\\":[{\\"Name\\":\\"governance\\",\\"Email\\":\\"wibud5210+10@gmail.com\\",\\"Mobile\\":\\"1234\\",\\"Position\\":\\"Other\\"}]}'],
+ 'Name' => ['title' => '基线项名称', 'description' => '基线项名称。', 'type' => 'string', 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Skip' => ['title' => '是否跳过基线项', 'description' => '是否跳过基线项。取值：'."\n"
+ ."\n"
+ .'- false：不跳过。'."\n"
+ .'- true：跳过。', 'type' => 'boolean', 'example' => 'false'],
+ 'Version' => ['title' => '基线项版本', 'description' => '基线项版本。', 'type' => 'string', 'example' => '1.0'],
],
],
],
- 'DisplayName' => [
- 'title' => '账号展示名称',
- 'description' => '账号显示名称。',
- 'type' => 'string',
- 'example' => 'test-account',
- ],
- 'FolderId' => [
- 'title' => '父资源夹ID',
- 'description' => '父资源夹ID。',
- 'type' => 'string',
- 'example' => 'fd-5ESoku****',
- ],
- 'PayerAccountUid' => [
- 'title' => '结算账号ID',
- 'description' => '结算账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '19534534552*****',
- ],
+ 'DisplayName' => ['title' => '账号展示名称', 'description' => '账号显示名称。', 'type' => 'string', 'example' => 'test-account'],
+ 'FolderId' => ['title' => '父资源夹ID', 'description' => '父资源夹ID。', 'type' => 'string', 'example' => 'fd-5ESoku****'],
+ 'PayerAccountUid' => ['title' => '结算账号ID', 'description' => '结算账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '19534534552*****'],
'Tag' => [
'description' => '标签。',
'type' => 'array',
@@ -946,35 +820,15 @@
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'product',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'governance',
- ],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'product'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'governance'],
],
],
],
],
],
- 'MasterAccountUid' => [
- 'title' => '所属的Master账号ID',
- 'description' => '所属的资源目录管理账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '19534534552*****',
- ],
- 'PayerAccountUid' => [
- 'title' => '结算账号ID',
- 'description' => '结算账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '19534534552*****',
- ],
+ 'MasterAccountUid' => ['title' => '所属的Master账号ID', 'description' => '所属的资源目录管理账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '19534534552*****'],
+ 'PayerAccountUid' => ['title' => '结算账号ID', 'description' => '结算账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '19534534552*****'],
'Progress' => [
'title' => '基线实施进度',
'description' => '基线实施进度。',
@@ -983,98 +837,77 @@
'description' => '实施进度。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '基线项名称',
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Status' => [
- 'title' => '基线项实施状态',
- 'description' => '基线项实施状态。取值：'."\n"
- ."\n"
- .'- Pending：等待中。'."\n"
- .'- Running：实施中。'."\n"
- .'- Finished：实施成功。'."\n"
- .'- Failed：实施失败。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
+ 'Name' => ['title' => '基线项名称', 'description' => '基线项名称。', 'type' => 'string', 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Status' => ['title' => '基线项实施状态', 'description' => '基线项实施状态。取值：'."\n"
+ ."\n"
+ .'- Pending：等待中。'."\n"
+ .'- Running：实施中。'."\n"
+ .'- Finished：实施成功。'."\n"
+ .'- Failed：实施失败。', 'type' => 'string', 'example' => 'Running'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '768F908D-A66A-5A5D-816C-20C93CBBFEE3',
- ],
- 'Status' => [
- 'title' => '账号注册状态',
- 'description' => '账号注册状态。取值：'."\n"
- ."\n"
- .'- Pending：等待中。'."\n"
- .'- Running：创建实施中。'."\n"
- .'- Finished：创建成功。'."\n"
- .'- Failed：创建失败。'."\n"
- .'- Scheduling：调度中。'."\n"
- .'- ScheduleFailed：调度失败。',
- 'type' => 'string',
- 'example' => 'Finished',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间。',
- 'type' => 'string',
- 'example' => '2021-11-01T02:38:27Z',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '768F908D-A66A-5A5D-816C-20C93CBBFEE3'],
+ 'Status' => ['title' => '账号注册状态', 'description' => '账号注册状态。取值：'."\n"
+ ."\n"
+ .'- Pending：等待中。'."\n"
+ .'- Running：创建实施中。'."\n"
+ .'- Finished：创建成功。'."\n"
+ .'- Failed：创建失败。'."\n"
+ .'- Scheduling：调度中。'."\n"
+ .'- ScheduleFailed：调度失败。', 'type' => 'string', 'example' => 'Finished'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-11-01T02:38:27Z'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is not valid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '您的请求中存在参数缺失或者参数无效。'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user does not exist.',
- ],
- [
- 'errorCode' => 'InvalidBlueprint.NotFound',
- 'errorMessage' => 'The specified blueprint does not exist.',
- ],
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user does not exist.', 'description' => '用户不存在。'],
+ ['errorCode' => 'InvalidBlueprint.NotFound', 'errorMessage' => 'The specified blueprint does not exist.', 'description' => '蓝图实例不存在。'],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取账号工厂中注册账号详情',
+ 'summary' => '获取账号工厂中注册账号详情。',
+ 'changeSet' => [
+ ['createdAt' => '2024-10-12T08:23:52.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-07-19T07:42:33.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
+ ['createdAt' => '2024-03-12T08:03:51.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-18T08:19:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEnrolledAccount'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:GetEnrolledAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountUid\\": 0,\\n \\"BaselineId\\": \\"afb-bp1adadfadsf***\\",\\n \\"BaselineItems\\": [\\n {\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"Notifications\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"GroupKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"account_msg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Contacts\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aa\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"PmsgStatus\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"EmailStatus\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"SmsStatus\\\\\\\\\\\\\\":1}]}\\",\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Skip\\": false,\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2021-11-01T02:38:27Z\\",\\n \\"DisplayName\\": \\"test-account\\",\\n \\"ErrorInfo\\": {\\n \\"Code\\": \\"EntityAlreadyExists.Role\\",\\n \\"Message\\": \\"The role already exists.\\",\\n \\"Recommend\\": \\"https://next.api.aliyun.com/troubleshoot?q=EntityAlreadyExists.Role\\\\\\\\u0026product=Ram\\",\\n \\"RequestId\\": \\"6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E\\"\\n },\\n \\"FolderId\\": \\"fd-5ESoku****\\",\\n \\"Initialized\\": true,\\n \\"Inputs\\": {\\n \\"AccountNamePrefix\\": \\"test-account\\",\\n \\"AccountUid\\": 0,\\n \\"BaselineItems\\": [\\n {\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"Contacts\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"governance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Email\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"wibud5210+10@gmail.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Mobile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1234\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Position\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Other\\\\\\\\\\\\\\"}]}\\",\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Skip\\": false,\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"DisplayName\\": \\"test-account\\",\\n \\"FolderId\\": \\"fd-5ESoku****\\",\\n \\"PayerAccountUid\\": 0,\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"product\\",\\n \\"Value\\": \\"governance\\"\\n }\\n ]\\n },\\n \\"MasterAccountUid\\": 0,\\n \\"PayerAccountUid\\": 0,\\n \\"Progress\\": [\\n {\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ],\\n \\"RequestId\\": \\"768F908D-A66A-5A5D-816C-20C93CBBFEE3\\",\\n \\"Status\\": \\"Finished\\",\\n \\"UpdateTime\\": \\"2021-11-01T02:38:27Z\\"\\n}","type":"json"}]',
- 'title' => '获取账号工厂中注册账号详情',
],
- 'GetAccountFactoryBaseline' => [
- 'summary' => '获取账号工厂基线详情。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAccountFactoryBaselineItems' => [
+ 'summary' => '获取云治理中心账号工厂支持的基线项列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1083,45 +916,65 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceARZHCM'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'BaselineId',
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => '基线项类型。', 'type' => 'string', 'required' => false, 'example' => 'AccountFactory'],
+ ],
+ [
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '基线ID。',
- 'type' => 'string',
+ 'description' => '基线项名称列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '基线项名称。', 'type' => 'string', 'required' => false, 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
'required' => false,
- 'example' => 'afb-bp1nf0enuzb89az*****',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Versions',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
+ 'description' => '基线项版本列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '基线项版本。', 'type' => 'string', 'required' => false, 'example' => '1.0'],
'required' => false,
- 'example' => 'cn-hangzhou',
],
],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询返回结果下一页的令牌。首次调用API不需要NextToken。', 'type' => 'string', 'required' => false, 'example' => 'AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页的最大数据条数。'."\n"
+ ."\n"
+ .'取值范围：1~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '100'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ResponseBaseResult<GetAccountFactoryBaselineResponse>',
- 'description' => '基线配置。',
+ 'title' => 'ResponsePageResult<ListAccountFactoryBaselineItemsResponse>',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'BaselineId' => [
- 'description' => '基线ID。',
- 'type' => 'string',
- 'example' => 'afb-bp16ae2k8a3yo3d*****',
- ],
'BaselineItems' => [
'description' => '基线项列表。',
'type' => 'array',
@@ -1129,108 +982,68 @@
'description' => '基线项配置。',
'type' => 'object',
'properties' => [
- 'Config' => [
- 'description' => '基线项的配置。'."\n"
- ."\n"
- .'格式为JSON字符串。',
- 'type' => 'string',
- 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}',
- ],
- 'Name' => [
- 'description' => '基线项的名称。',
- 'type' => 'string',
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Version' => [
- 'description' => '基线项的版本。',
- 'type' => 'string',
- 'example' => '1.0',
+ 'DependsOn' => [
+ 'description' => '基线项依赖。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '依赖配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '基线项名称。', 'type' => 'string', 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'],
+ 'Type' => ['description' => '基线项类型。', 'type' => 'string', 'example' => 'AccountFactory'],
+ 'Version' => ['description' => '基线项版本。', 'type' => 'string', 'example' => '1.0'],
+ ],
+ ],
],
+ 'Description' => ['description' => '基线项描述。', 'type' => 'string', 'example' => 'Notification.'],
+ 'Name' => ['description' => '基线项名称。', 'type' => 'string', 'example' => 'ACS-BP_ACCOUNT_FACTORY_ACCOUNT_NOTIFICATION'],
+ 'Type' => ['description' => '基线项类型。', 'type' => 'string', 'example' => 'AccountFactory'],
+ 'Version' => ['description' => '基线项版本。', 'type' => 'string', 'example' => '1.0'],
],
],
],
- 'BaselineName' => [
- 'description' => '基线名称。',
- 'type' => 'string',
- 'example' => 'Default',
- 'default' => 'Default',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2022-11-28T00:46:34Z',
- ],
- 'Description' => [
- 'description' => '基线描述。',
- 'type' => 'string',
- 'example' => '默认基线',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '60D54503-F1F6-51B6-B6FA-A70CBDA2A68C',
- ],
- 'Type' => [
- 'description' => '基线类型。取值：'."\n"
- .'- System：系统默认基线。'."\n"
- .'- Custom：用户自定义基线。',
- 'type' => 'string',
- 'example' => 'Custom',
- ],
- 'UpdateTime' => [
- 'description' => '更新时间。',
- 'type' => 'string',
- 'example' => '2022-11-02T01:00:07Z',
- ],
+ 'NextToken' => ['description' => '查询返回结果下一页的令牌。', 'type' => 'string', 'example' => 'AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B40D73D8-76AC-5D3C-AC63-4FC8AFCE6671'],
],
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is not valid.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user does not exist.',
- ],
- [
- 'errorCode' => 'InvalidBaseline.NotFound',
- 'errorMessage' => 'The specified baseline does not exist.',
- ],
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取账号工厂支持的基线项列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccountFactoryBaselineItems'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'governance:ListAccountFactoryBaselineItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BaselineId\\": \\"afb-bp16ae2k8a3yo3d*****\\",\\n \\"BaselineItems\\": [\\n {\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"Notifications\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"GroupKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"account_msg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Contacts\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aa\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"PmsgStatus\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"EmailStatus\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"SmsStatus\\\\\\\\\\\\\\":1}]}\\",\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"BaselineName\\": \\"Default\\",\\n \\"CreateTime\\": \\"2022-11-28T00:46:34Z\\",\\n \\"Description\\": \\"默认基线\\",\\n \\"RequestId\\": \\"60D54503-F1F6-51B6-B6FA-A70CBDA2A68C\\",\\n \\"Type\\": \\"Custom\\",\\n \\"UpdateTime\\": \\"2022-11-02T01:00:07Z\\"\\n}","type":"json"}]',
- 'title' => '获取账号工厂基线详情',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BaselineItems\\": [\\n {\\n \\"DependsOn\\": [\\n {\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Type\\": \\"AccountFactory\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"Description\\": \\"Notification.\\",\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_ACCOUNT_NOTIFICATION\\",\\n \\"Type\\": \\"AccountFactory\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod\\",\\n \\"RequestId\\": \\"B40D73D8-76AC-5D3C-AC63-4FC8AFCE6671\\"\\n}","type":"json"}]',
],
'ListAccountFactoryBaselines' => [
'summary' => '获取账号工厂基线列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1242,47 +1055,28 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceH3XRB0',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceH3XRB0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '查询返回结果下一页的令牌。'."\n"
- ."\n"
- .'首次调用API不需要NextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****',
- ],
+ 'schema' => ['description' => '查询返回结果下一页的令牌。'."\n"
+ ."\n"
+ .'首次调用API不需要NextToken。', 'type' => 'string', 'required' => false, 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '每页的最大数据条数。'."\n"
- ."\n"
- .'取值范围：1~100。默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '每页的最大数据条数。'."\n"
+ ."\n"
+ .'取值范围：1~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
@@ -1299,26 +1093,10 @@
'description' => '基线列表。',
'type' => 'object',
'properties' => [
- 'BaselineId' => [
- 'description' => '基线ID。',
- 'type' => 'string',
- 'example' => 'afb-bp1durvn3lgqe28v****',
- ],
- 'BaselineName' => [
- 'description' => '基线名称。',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2021-11-30T09:09:28Z',
- ],
- 'Description' => [
- 'description' => '基线描述。',
- 'type' => 'string',
- 'example' => '默认基线',
- ],
+ 'BaselineId' => ['description' => '基线ID。', 'type' => 'string', 'example' => 'afb-bp1durvn3lgqe28v****'],
+ 'BaselineName' => ['description' => '基线名称。', 'type' => 'string', 'example' => 'Default'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-11-30T09:09:28Z'],
+ 'Description' => ['description' => '基线描述。', 'type' => 'string', 'example' => 'Default baseline'],
'Type' => [
'description' => '基线类型。取值：'."\n"
."\n"
@@ -1328,283 +1106,55 @@
'enumValueTitles' => [],
'example' => 'Custom',
],
- 'UpdateTime' => [
- 'description' => '更新时间。',
- 'type' => 'string',
- 'example' => '2022-12-29T07:08:40Z',
- ],
+ 'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2022-12-29T07:08:40Z'],
],
],
],
- 'NextToken' => [
- 'description' => '查询返回结果下一页的令牌。',
- 'type' => 'string',
- 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '3245E413-7CDD-5287-8988-6A94DE8A8369',
- ],
+ 'NextToken' => ['description' => '查询返回结果下一页的令牌。', 'type' => 'string', 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '3245E413-7CDD-5287-8988-6A94DE8A8369'],
],
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user does not exist.',
- ],
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user does not exist.', 'description' => '用户不存在。'],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Baselines\\": [\\n {\\n \\"BaselineId\\": \\"afb-bp1durvn3lgqe28v****\\",\\n \\"BaselineName\\": \\"Default\\",\\n \\"CreateTime\\": \\"2021-11-30T09:09:28Z\\",\\n \\"Description\\": \\"默认基线\\",\\n \\"Type\\": \\"Custom\\",\\n \\"UpdateTime\\": \\"2022-12-29T07:08:40Z\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****\\",\\n \\"RequestId\\": \\"3245E413-7CDD-5287-8988-6A94DE8A8369\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Baselines\\": [\\n {\\n \\"BaselineId\\": \\"afb-bp1durvn3lgqe28v****\\",\\n \\"BaselineName\\": \\"Default\\",\\n \\"CreateTime\\": \\"2021-11-30T09:09:28Z\\",\\n \\"Description\\": \\"Default baseline\\",\\n \\"Type\\": \\"Custom\\",\\n \\"UpdateTime\\": \\"2022-12-29T07:08:40Z\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****\\",\\n \\"RequestId\\": \\"3245E413-7CDD-5287-8988-6A94DE8A8369\\"\\n}","type":"json"}]',
'title' => '获取账号工厂基线列表',
- ],
- 'CreateAccountFactoryBaseline' => [
- 'summary' => '创建账号工厂基线。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernance7SBZ97',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'BaselineName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default',
- 'default' => 'Default',
- ],
- ],
- [
- 'name' => 'BaselineItems',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '基线项列表。'."\n"
- ."\n"
- .'您可以调用[ListAccountFactoryBaselineItems](~~ListAccountFactoryBaselineItems~~)，获取云治理中心支持的账号工厂基线项列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '基线项配置。',
- 'type' => 'object',
- 'properties' => [
- 'Config' => [
- 'description' => '基线项配置。格式为JSON字符串。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"EnabledServices":["CEN_TR","CDT","CMS","KMS"]}',
- ],
- 'Name' => [
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Version' => [
- 'description' => '基线项版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0',
- 'default' => '1.0',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default Baseline.',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T07:42:33.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ResponseBaseResult<CreateAccountFactoryBaselineResponse>',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'BaselineId' => [
- 'description' => '基线ID。',
- 'type' => 'string',
- 'example' => 'afb-bp1e6ixtiwupap8m****',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A5592E2E-0FC4-557C-B989-DF229B5EBE13',
- ],
- ],
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccountFactoryBaselines'],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BaselineId\\": \\"afb-bp1e6ixtiwupap8m****\\",\\n \\"RequestId\\": \\"A5592E2E-0FC4-557C-B989-DF229B5EBE13\\"\\n}","type":"json"}]',
- 'title' => '创建账号工厂基线',
- ],
- 'DeleteAccountFactoryBaseline' => [
- 'summary' => '删除账号工厂基线。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'BaselineId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'afb-bp1durvn3lgqe28v****',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ResponseBaseResult<Void>',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0F45D888-8C4D-55E5-ACA2-D1515159181D',
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'governance:ListAccountFactoryBaselines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
+ 'additionalActions' => [],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F45D888-8C4D-55E5-ACA2-D1515159181D\\"\\n}","type":"json"}]',
- 'title' => '删除账号工厂基线',
],
- 'ListAccountFactoryBaselineItems' => [
- 'summary' => '获取云治理中心账号工厂支持的基线项列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListEnrolledAccounts' => [
+ 'summary' => '获取账号工厂中注册账号的列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1616,448 +1166,122 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceARZHCM',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceARZHCM'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线项类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AccountFactory',
- ],
- ],
- [
- 'name' => 'Names',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '基线项名称列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Versions',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '基线项版本列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '基线项版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0',
- ],
- 'required' => false,
- ],
- ],
- [
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '查询返回结果下一页的令牌。首次调用API不需要NextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod',
- ],
+ 'schema' => ['title' => '查询返回结果下一页的令牌。首次调用API不需要NextToken', 'description' => '查询返回结果下一页的令牌。'."\n"
+ ."\n"
+ .'首次调用API不需要NextToken。', 'type' => 'string', 'required' => false, 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
+ 'allowEmptyValue' => false,
'schema' => [
- 'description' => '每页的最大数据条数。'."\n"
+ 'title' => '每页的最大数据条数', 'description' => '每页的最大数据条数。'."\n"
."\n"
- .'取值范围：1~100。默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '100',
+ .'取值范围：1~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'exclusiveMaximum' => false, 'minimum' => '1', 'exclusiveMinimum' => false, 'example' => '10',
+ 'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ResponsePageResult<ListAccountFactoryBaselineItemsResponse>',
- 'description' => '返回结果。',
+ 'title' => '注册账号列表',
+ 'description' => '注册账号列表。',
'type' => 'object',
'properties' => [
- 'BaselineItems' => [
- 'description' => '基线项列表。',
+ 'EnrolledAccounts' => [
+ 'title' => '账号列表',
+ 'description' => '账号列表。',
'type' => 'array',
'items' => [
- 'description' => '基线项配置。',
+ 'description' => '账号。',
'type' => 'object',
'properties' => [
- 'DependsOn' => [
- 'description' => '基线项依赖。',
- 'type' => 'array',
- 'items' => [
- 'description' => '依赖配置。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC',
- ],
- 'Type' => [
- 'description' => '基线项类型。',
- 'type' => 'string',
- 'example' => 'AccountFactory',
- ],
- 'Version' => [
- 'description' => '基线项版本。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- ],
- ],
- ],
- 'Description' => [
- 'description' => '基线项描述。',
- 'type' => 'string',
- 'example' => 'Notification.',
- ],
- 'Name' => [
- 'description' => '基线项名称。',
- 'type' => 'string',
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_ACCOUNT_NOTIFICATION',
- ],
- 'Type' => [
- 'description' => '基线项类型。',
- 'type' => 'string',
- 'example' => 'AccountFactory',
- ],
- 'Version' => [
- 'description' => '基线项版本。',
+ 'AccountUid' => ['title' => '账号ID', 'description' => '账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '19534534552*****'],
+ 'BaselineId' => ['description' => '当前应用的基线ID。', 'type' => 'string', 'example' => 'afb-bp1durvn3lgqe28v****'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-11-01T02:38:27Z'],
+ 'DisplayName' => ['title' => '账号显示名称', 'description' => '账号显示名称。', 'type' => 'string', 'example' => 'TestAccount'],
+ 'FolderId' => ['title' => '父资源夹ID', 'description' => '父资源夹ID。', 'type' => 'string', 'example' => 'fd-5ESoku****'],
+ 'PayerAccountUid' => ['title' => '结算账号ID', 'description' => '结算账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '13161210500*****'],
+ 'Status' => [
+ 'title' => '创建状态',
+ 'description' => '创建状态。取值：'."\n"
+ ."\n"
+ .'- Pending：等待中。'."\n"
+ .'- Running：创建实施中。'."\n"
+ .'- Finished：创建成功。'."\n"
+ .'- Failed：创建失败。'."\n"
+ .'- Scheduling：调度中。'."\n"
+ .'- ScheduleFailed：调度失败。',
'type' => 'string',
- 'example' => '1.0',
+ 'example' => 'Running',
+ 'enum' => [],
],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-11-01T02:38:27Z'],
],
],
],
- 'NextToken' => [
- 'description' => '查询返回结果下一页的令牌。',
- 'type' => 'string',
- 'example' => 'AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'B40D73D8-76AC-5D3C-AC63-4FC8AFCE6671',
- ],
+ 'NextToken' => ['title' => '查询返回结果下一页的令牌', 'description' => '查询返回结果下一页的令牌。', 'type' => 'string', 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '768F908D-A66A-5A5D-816C-20C93CBBFEE3'],
],
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BaselineItems\\": [\\n {\\n \\"DependsOn\\": [\\n {\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_VPC\\",\\n \\"Type\\": \\"AccountFactory\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"Description\\": \\"Notification.\\",\\n \\"Name\\": \\"ACS-BP_ACCOUNT_FACTORY_ACCOUNT_NOTIFICATION\\",\\n \\"Type\\": \\"AccountFactory\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod\\",\\n \\"RequestId\\": \\"B40D73D8-76AC-5D3C-AC63-4FC8AFCE6671\\"\\n}","type":"json"}]',
- 'title' => '获取账号工厂支持的基线项列表',
- ],
- 'UpdateAccountFactoryBaseline' => [
- 'summary' => '更新账号工厂基线。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'BaselineId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'afb-bp1pq3emlkt27vsj****',
- ],
- ],
- [
- 'name' => 'BaselineName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义基线',
- ],
- ],
- [
- 'name' => 'BaselineItems',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '基线项列表。'."\n"
- ."\n"
- .'您可以调用[ListAccountFactoryBaselineItems](~~ListAccountFactoryBaselineItems~~)，获取云治理中心支持的账号工厂基线项列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '基线项配置。'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Config' => [
- 'description' => '基线项配置。格式为JSON字符串。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"EnabledServices":["CEN_TR","CDT","CMS","KMS"]}',
- ],
- 'Name' => [
- 'description' => '基线项名称。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'."\n",
- ],
- 'Version' => [
- 'description' => '基线项版本。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0'."\n",
- 'default' => '1.0',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基线描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '默认基线',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ResponseBaseResult<Void>',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C18A891D-7B04-51A1-AAC6-201727A361CE',
- ],
- ],
- ],
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '您的请求中存在参数缺失或者参数无效。'],
],
- ],
- 'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user does not exist.', 'description' => '用户不存在。'],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C18A891D-7B04-51A1-AAC6-201727A361CE\\"\\n}","type":"json"}]',
- 'title' => '更新账号工厂基线',
- ],
- 'RunEvaluation' => [
- 'summary' => '运行云治理中心治理检测。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取账号工厂中注册账号的列表',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-11T10:52:39.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T07:42:33.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-01-18T08:19:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceMBMBHG',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnrolledAccounts'],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'AccountId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '成员账号ID。该参数仅适用于多账号检测模式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '176618589410****',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'Scope',
- 'in' => 'query',
- 'schema' => [
- 'description' => '治理成熟度检测范围。取值：'."\n"
- ."\n"
- .'- Account（默认）：运行单账号治理成熟度检测，仅检测当前账号。'."\n"
- .'- ResourceDirectory：运行多账号治理成熟度检测，即检测资源目录所有成员账号。操作前，需要先升级至多账号治理成熟度检测。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ResourceDirectory',
- ],
- ],
- [
- 'name' => 'MetricIds',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '需要检测的检测项ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '检测项ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xfyve5****',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'governance:ListEnrolledAccounts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ResponseBaseResult<RunEvaluationResponse>',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D3E2A3A-F2B8-578D-9659-3195F94A****',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D3E2A3A-F2B8-578D-9659-3195F94A****\\"\\n}","type":"json"}]',
- 'title' => '运行治理检测',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnrolledAccounts\\": [\\n {\\n \\"AccountUid\\": 0,\\n \\"BaselineId\\": \\"afb-bp1durvn3lgqe28v****\\",\\n \\"CreateTime\\": \\"2021-11-01T02:38:27Z\\",\\n \\"DisplayName\\": \\"TestAccount\\",\\n \\"FolderId\\": \\"fd-5ESoku****\\",\\n \\"PayerAccountUid\\": 0,\\n \\"Status\\": \\"Running\\",\\n \\"UpdateTime\\": \\"2021-11-01T02:38:27Z\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****\\",\\n \\"RequestId\\": \\"768F908D-A66A-5A5D-816C-20C93CBBFEE3\\"\\n}","errorExample":""},{"type":"xml","example":"<ListEnrolledAccountsResponse>\\n <RequestId>768F908D-A66A-5A5D-816C-20C93CBBFEE3</RequestId>\\n <NextToken>AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****</NextToken>\\n <EnrolledAccounts>\\n <Status>Running</Status>\\n <CreateTime>2021-11-01T02:38:27Z</CreateTime>\\n <DisplayName>TestAccount</DisplayName>\\n <FolderId>fd-5ESoku****</FolderId>\\n <UpdateTime>2021-11-01T02:38:27Z</UpdateTime>\\n <AccountUid>1234</AccountUid>\\n <PayerAccountUid>1234</PayerAccountUid>\\n </EnrolledAccounts>\\n</ListEnrolledAccountsResponse>","errorExample":""}]',
],
'ListEvaluationMetadata' => [
- 'summary' => '获取所有可用的治理检测评估项的信息，包括名称、ID、描述、阶段、资源明细元数据和修复指引。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2069,55 +1293,43 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceMBMBHG',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceMBMBHG'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'description' => '语言类型。治理检测定义将以此语言返回。取值：'."\n"
- ."\n"
- .'- en：英文。'."\n"
- .'- zh：中文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '语言类型。治理检测定义将以此语言返回。取值：'."\n"
+ ."\n"
+ .'- en：英文。'."\n"
+ .'- zh：中文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'LensCode',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '专项检测代码。取值：'."\n"
+ ."\n"
+ .'- basic（默认）：基础模型（治理成熟度）检测。'."\n"
+ .'- ack：容器构建专项检测。'."\n"
+ .'- ai：机器学习专项检测。'."\n"
+ .'- nis：网络服务专项检测。', 'type' => 'string', 'required' => false, 'example' => 'ack'],
],
[
'name' => 'TopicCode',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '治理专题code',
- 'description' => '治理专题code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ResourceUtilization',
- ],
+ 'schema' => ['title' => '治理专题code', 'description' => '治理专题code', 'type' => 'string', 'required' => false, 'example' => 'ResourceUtilization'],
+ ],
+ [
+ 'name' => 'EvaluationDomain',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -2141,31 +1353,11 @@
'description' => '特定元数据类型下的元数据对象列表。',
'type' => 'object',
'properties' => [
- 'Category' => [
- 'description' => '检测项所属的支柱。',
- 'type' => 'string',
- 'example' => 'Security',
- ],
- 'Description' => [
- 'description' => '检测项描述。',
- 'type' => 'string',
- 'example' => '主账号 AccessKey 等同于主账号权限，无法进行条件限制（如访问来源 IP、访问时间等），一旦泄漏风险极大。有存在的主账号 AccessKey，则视为不合规。',
- ],
- 'DisplayName' => [
- 'description' => '显示名称。',
- 'type' => 'string',
- 'example' => '主账号存在启用的 AccessKey',
- ],
- 'Id' => [
- 'description' => '元数据随机ID。',
- 'type' => 'string',
- 'example' => 'pxgtda****',
- ],
- 'RecommendationLevel' => [
- 'description' => '检测项推荐治理等级。',
- 'type' => 'string',
- 'example' => 'High',
- ],
+ 'Category' => ['description' => '检测项所属的支柱。', 'type' => 'string', 'example' => 'Security'],
+ 'Description' => ['description' => '检测项描述。', 'type' => 'string', 'example' => 'If you use an AccessKey pair of an Alibaba Cloud account, you have full permissions that cannot be restricted by conditions such as source IP address or access time. Once leaked, the risk is extremely high. If an AccessKey pair exists for the Alibaba Cloud account, it is considered non-compliant.'],
+ 'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'An AccessKey pair is enabled for the Alibaba Cloud account.'],
+ 'Id' => ['description' => '元数据随机ID。', 'type' => 'string', 'example' => 'pxgtda****'],
+ 'RecommendationLevel' => ['description' => '检测项推荐治理等级。', 'type' => 'string', 'example' => 'High'],
'RemediationMetadata' => [
'description' => '修复元数据。',
'type' => 'object',
@@ -2184,25 +1376,13 @@
'description' => '修复动作。',
'type' => 'object',
'properties' => [
- 'Classification' => [
- 'description' => '修复方式类别。'."\n"
- ."\n"
- .'> 仅当`RemediationType`为`Analysis`时返回该参数。',
- 'type' => 'string',
- 'example' => 'UnusedAccessKeyInRamUser',
- ],
- 'CostDescription' => [
- 'description' => '修复花费。',
- 'type' => 'string',
- 'example' => '当前操作不产生费用',
- ],
- 'Description' => [
- 'description' => '修复描述。'."\n"
- ."\n"
- .'> 仅当`RemediationType`为`Analysis`时返回该参数。',
- 'type' => 'string',
- 'example' => 'RAM 用户既启用控制台登录又保有子账号AK，且子账号AK从未使用。',
- ],
+ 'Classification' => ['description' => '修复方式类别。'."\n"
+ ."\n"
+ .'> 仅当`RemediationType`为`Analysis`时返回该参数。', 'type' => 'string', 'example' => 'UnusedAccessKeyInRamUser'],
+ 'CostDescription' => ['description' => '修复花费。', 'type' => 'string', 'example' => 'You are not charged for this operation.'],
+ 'Description' => ['description' => '修复描述。'."\n"
+ ."\n"
+ .'> 仅当`RemediationType`为`Analysis`时返回该参数。', 'type' => 'string', 'example' => 'A RAM user has both console logon and an AccessKey pair enabled, but the AccessKey pair has never been used.'],
'Guidance' => [
'description' => '修复内容。',
'type' => 'array',
@@ -2210,53 +1390,25 @@
'description' => '修复内容。',
'type' => 'object',
'properties' => [
- 'ButtonName' => [
- 'description' => '修复步骤按钮显示名称。',
- 'type' => 'string',
- 'example' => '手动修复',
- ],
- 'ButtonRef' => [
- 'description' => '修复步骤按钮跳转链接。',
- 'type' => 'string',
- 'example' => 'https://ram.console.aliyun.com/users',
- ],
- 'Content' => [
- 'description' => '修复步骤内容。',
- 'type' => 'string',
- 'example' => '需进行腾挪操作，步骤如下：</br>1. 进入 RAM 控制台，「身份管理」-「用户」，单击「创建用户」。</br>2. 填写「登录名称」，下方「访问方式」，勾选 OpenAPI 调用访问。</br>3. 创建成功后，保存该 RAM 用户的 AccessKey，勾选该 RAM 用户，单击「添加权限」，在弹出的侧边栏中，添加 AdministratorAccess权限。</br>4. 在程序中将主账号 AccessKey 替换为上步骤中创建的 RAM 用户 AccessKey，在相应的测试环境中验证程序逻辑是否正常。</br>5. 如果验证通过，将程序发布到生产环境，并将主账号 AccessKey 禁用，观察应用是否正常。</br>6. 如果应用正常，则等待一定时间（如 3 个月），将禁用的主账号 AccessKey 删除。',
- ],
- 'Title' => [
- 'description' => '修复步骤标题。',
- 'type' => 'string',
- 'example' => '情况三：针对「90天内使用中的 AccessKey」',
- ],
+ 'ButtonName' => ['description' => '修复步骤按钮显示名称。', 'type' => 'string', 'example' => 'Manual fix'],
+ 'ButtonRef' => ['description' => '修复步骤按钮跳转链接。', 'type' => 'string', 'example' => 'https://ram.console.aliyun.com/users'],
+ 'Content' => ['description' => '修复步骤内容。', 'type' => 'string', 'example' => 'You must replace the AccessKey pair of your Alibaba Cloud account. To do so, perform the following steps:</br>1. Log on to the RAM console. In the left-side navigation pane, choose Identities > Users. On the Users page, click Create User.</br>2. On the Create User page, enter a logon name and select OpenAPI Access for the Access Mode parameter.</br>3. After the RAM user is created, save the AccessKey pair. Then, find the user that you created on the Users page and click Add Permissions in the Actions column. In the Grant Permission panel, find the AdministratorAccess policy and attach it to the RAM user.</br>4. In a program, replace the AccessKey pair of the Alibaba Cloud account with the AccessKey pair of the RAM user created in the previous step and check whether the program runs as expected in the test environment.</br>5. If the program runs as expected, publish the program to the production environment and disable the previous AccessKey pair of your Alibaba Cloud account. Then, check whether the program runs as expected.</br>6. If the program runs as expected, delete the disabled AccessKey pair after the specified period of time, such as 90 days.'],
+ 'Title' => ['description' => '修复步骤标题。', 'type' => 'string', 'example' => 'Scenario 3: AccessKey pair that is used within the last 90 days'],
],
],
],
- 'Notice' => [
- 'description' => '修复注意事项。',
- 'type' => 'string',
- 'example' => '此治理项会在配置审计中开启AccessKey及权限治理最佳实践合规包，从AccessKey、阿里云账号、RAM用户的设置和使用方式等方面进行检测。',
- ],
- 'Suggestion' => [
- 'description' => '修复建议。'."\n"
- ."\n"
- .'> 仅当`RemediationType`为`Analysis`时返回该参数。',
- 'type' => 'string',
- 'example' => '该RAM用户既启用控制台登录又保有子账号AK，且子账号AccessKey从未使用过，因此建议禁用该AccessKey。禁用90天后，如果没有发生与该AcccessKey相关的问题，则可以直接删除该AccessKey。',
- ],
+ 'Notice' => ['description' => '修复注意事项。', 'type' => 'string', 'example' => 'This governance item enables the Best Practices for AccessKey and Permission Governance compliance package in Cloud Config to check the settings and usage of AccessKey pairs, Alibaba Cloud accounts, and RAM users.'],
+ 'Suggestion' => ['description' => '修复建议。'."\n"
+ ."\n"
+ .'> 仅当`RemediationType`为`Analysis`时返回该参数。', 'type' => 'string', 'example' => 'Console logon is enabled for the RAM user and the RAM user owns an AccessKey pair, while the AccessKey pair has never been used by the RAM user. We recommend that you disable the AccessKey pair for 90 days. If no related issue occurs during this period, you can delete the AccessKey pair.'],
],
],
],
- 'RemediationType' => [
- 'description' => '修复类型。取值：'."\n"
- ."\n"
- .'- Manual：手动修复。'."\n"
- .'- QuickFix：快速修复。'."\n"
- .'- Analysis：辅助决策。',
- 'type' => 'string',
- 'example' => 'Manual',
- ],
+ 'RemediationType' => ['description' => '修复类型。取值：'."\n"
+ ."\n"
+ .'- Manual：手动修复。'."\n"
+ .'- QuickFix：快速修复。'."\n"
+ .'- Analysis：辅助决策。', 'type' => 'string', 'example' => 'Manual'],
],
],
],
@@ -2273,238 +1425,75 @@
'description' => '资源属性元数据。',
'type' => 'object',
'properties' => [
- 'DisplayName' => [
- 'description' => '属性显示名称。',
- 'type' => 'string',
- 'example' => 'AccessKey 最后使用时间',
- ],
- 'PropertyName' => [
- 'description' => '资源属性名称。',
- 'type' => 'string',
- 'example' => 'AkLastUsedTime',
- ],
- 'PropertyType' => [
- 'description' => '资源属性类型。',
- 'type' => 'string',
- 'example' => 'String',
- ],
+ 'DisplayName' => ['description' => '属性显示名称。', 'type' => 'string', 'example' => 'Last time the AccessKey pair was used'],
+ 'PropertyName' => ['description' => '资源属性名称。', 'type' => 'string', 'example' => 'AkLastUsedTime'],
+ 'PropertyType' => ['description' => '资源属性类型。', 'type' => 'string', 'example' => 'String'],
],
],
],
],
],
- 'Scope' => [
- 'description' => '检测项所属范围。取值：'."\n"
- ."\n"
- .'- Account：单账号检测项。'."\n"
- .'- ResourceDirectory：多账号检测项。',
- 'type' => 'string',
- 'example' => 'Account',
- ],
- 'Stage' => [
- 'description' => '检测项所处状态。取值：'."\n"
- ."\n"
- .'- Released：正式。'."\n"
- .'- Beta：预上线。',
- 'type' => 'string',
- 'example' => 'Released',
- ],
- 'TopicCode' => [
- 'title' => '所属治理专题code',
- 'description' => '所属治理专题code',
- 'type' => 'string',
- 'example' => 'ResourceUtilization',
- ],
+ 'Scope' => ['description' => '检测项所属范围。取值：'."\n"
+ ."\n"
+ .'- Account：单账号检测项。'."\n"
+ .'- ResourceDirectory：多账号检测项。', 'type' => 'string', 'example' => 'Account'],
+ 'Stage' => ['description' => '检测项所处状态。取值：'."\n"
+ ."\n"
+ .'- Released：正式。'."\n"
+ .'- Beta：预上线。', 'type' => 'string', 'example' => 'Released'],
+ 'TopicCode' => ['title' => '所属治理专题code', 'description' => '所属治理专题code', 'type' => 'string', 'example' => 'ResourceUtilization'],
],
],
],
- 'Type' => [
- 'description' => '元数据类型。取值：'."\n"
- ."\n"
- .'- Metric：检测项。',
- 'type' => 'string',
- 'example' => 'Metric',
- ],
+ 'Type' => ['description' => '元数据类型。取值：'."\n"
+ ."\n"
+ .'- Metric：检测项。', 'type' => 'string', 'example' => 'Metric'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1'],
],
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EvaluationMetadata\\": [\\n {\\n \\"Metadata\\": [\\n {\\n \\"Category\\": \\"Security\\",\\n \\"Description\\": \\"主账号 AccessKey 等同于主账号权限，无法进行条件限制（如访问来源 IP、访问时间等），一旦泄漏风险极大。有存在的主账号 AccessKey，则视为不合规。\\",\\n \\"DisplayName\\": \\"主账号存在启用的 AccessKey\\",\\n \\"Id\\": \\"pxgtda****\\",\\n \\"RecommendationLevel\\": \\"High\\",\\n \\"RemediationMetadata\\": {\\n \\"Remediation\\": [\\n {\\n \\"Actions\\": [\\n {\\n \\"Classification\\": \\"UnusedAccessKeyInRamUser\\",\\n \\"CostDescription\\": \\"当前操作不产生费用\\",\\n \\"Description\\": \\"RAM 用户既启用控制台登录又保有子账号AK，且子账号AK从未使用。\\",\\n \\"Guidance\\": [\\n {\\n \\"ButtonName\\": \\"手动修复\\",\\n \\"ButtonRef\\": \\"https://ram.console.aliyun.com/users\\",\\n \\"Content\\": \\"需进行腾挪操作，步骤如下：</br>1. 进入 RAM 控制台，「身份管理」-「用户」，单击「创建用户」。</br>2. 填写「登录名称」，下方「访问方式」，勾选 OpenAPI 调用访问。</br>3. 创建成功后，保存该 RAM 用户的 AccessKey，勾选该 RAM 用户，单击「添加权限」，在弹出的侧边栏中，添加 AdministratorAccess权限。</br>4. 在程序中将主账号 AccessKey 替换为上步骤中创建的 RAM 用户 AccessKey，在相应的测试环境中验证程序逻辑是否正常。</br>5. 如果验证通过，将程序发布到生产环境，并将主账号 AccessKey 禁用，观察应用是否正常。</br>6. 如果应用正常，则等待一定时间（如 3 个月），将禁用的主账号 AccessKey 删除。\\",\\n \\"Title\\": \\"情况三：针对「90天内使用中的 AccessKey」\\"\\n }\\n ],\\n \\"Notice\\": \\"此治理项会在配置审计中开启AccessKey及权限治理最佳实践合规包，从AccessKey、阿里云账号、RAM用户的设置和使用方式等方面进行检测。\\",\\n \\"Suggestion\\": \\"该RAM用户既启用控制台登录又保有子账号AK，且子账号AccessKey从未使用过，因此建议禁用该AccessKey。禁用90天后，如果没有发生与该AcccessKey相关的问题，则可以直接删除该AccessKey。\\"\\n }\\n ],\\n \\"RemediationType\\": \\"Manual\\"\\n }\\n ]\\n },\\n \\"ResourceMetadata\\": {\\n \\"ResourcePropertyMetadata\\": [\\n {\\n \\"DisplayName\\": \\"AccessKey 最后使用时间\\",\\n \\"PropertyName\\": \\"AkLastUsedTime\\",\\n \\"PropertyType\\": \\"String\\"\\n }\\n ]\\n },\\n \\"Scope\\": \\"Account\\",\\n \\"Stage\\": \\"Released\\",\\n \\"TopicCode\\": \\"ResourceUtilization\\"\\n }\\n ],\\n \\"Type\\": \\"Metric\\"\\n }\\n ],\\n \\"RequestId\\": \\"16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取治理检测项信息',
- ],
- 'ListEvaluationScoreHistory' => [
- 'summary' => '获取治理检测历史分数。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'summary' => '获取所有可用的治理检测评估项的信息，包括名称、ID、描述、阶段、资源明细元数据和修复指引。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T04:52:11.000Z', 'description' => '请求参数发生变更'],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceVMJHAB',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationMetadata'],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询的开始时间，格式：YYYY-MM-DD。'."\n"
- ."\n"
- .'最多查询最近180天的记录。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-06-11',
- ],
- ],
- [
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询的结束时间，格式：YYYY-MM-DD。'."\n"
- ."\n"
- .'默认为查询当前日期前7天的历史分数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-07-11',
- ],
- ],
- [
- 'name' => 'AccountId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '成员账号ID。该参数仅适用于多账号检测模式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '176618589410****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ResponseBaseResult<ListEvaluationScoreHistoryResponse>',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AC9BD94C-D20C-4D27-88D4-89E8D75C051B',
- ],
- 'ScoreHistory' => [
- 'description' => '历史检测分数。',
- 'type' => 'object',
- 'properties' => [
- 'TotalScoreHistory' => [
- 'description' => '历史检测分数。',
- 'type' => 'array',
- 'items' => [
- 'description' => '历史检测分数。',
- 'type' => 'object',
- 'properties' => [
- 'EvaluationTime' => [
- 'description' => '分数生成时间（UTC时间）。',
- 'type' => 'string',
- 'example' => '2024-06-30T03:34:02Z',
- ],
- 'Score' => [
- 'description' => '分数。'."\n"
- ."\n"
- .'取值范围：0~1。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.6753',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationMetadata',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC9BD94C-D20C-4D27-88D4-89E8D75C051B\\",\\n \\"ScoreHistory\\": {\\n \\"TotalScoreHistory\\": [\\n {\\n \\"EvaluationTime\\": \\"2024-06-30T03:34:02Z\\",\\n \\"Score\\": 0.6753\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取治理检测历史分数',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EvaluationMetadata\\": [\\n {\\n \\"Metadata\\": [\\n {\\n \\"Category\\": \\"Security\\",\\n \\"Description\\": \\"If you use an AccessKey pair of an Alibaba Cloud account, you have full permissions that cannot be restricted by conditions such as source IP address or access time. Once leaked, the risk is extremely high. If an AccessKey pair exists for the Alibaba Cloud account, it is considered non-compliant.\\",\\n \\"DisplayName\\": \\"An AccessKey pair is enabled for the Alibaba Cloud account.\\",\\n \\"Id\\": \\"pxgtda****\\",\\n \\"RecommendationLevel\\": \\"High\\",\\n \\"RemediationMetadata\\": {\\n \\"Remediation\\": [\\n {\\n \\"Actions\\": [\\n {\\n \\"Classification\\": \\"UnusedAccessKeyInRamUser\\",\\n \\"CostDescription\\": \\"You are not charged for this operation.\\",\\n \\"Description\\": \\"A RAM user has both console logon and an AccessKey pair enabled, but the AccessKey pair has never been used.\\",\\n \\"Guidance\\": [\\n {\\n \\"ButtonName\\": \\"Manual fix\\",\\n \\"ButtonRef\\": \\"https://ram.console.aliyun.com/users\\",\\n \\"Content\\": \\"You must replace the AccessKey pair of your Alibaba Cloud account. To do so, perform the following steps:</br>1. Log on to the RAM console. In the left-side navigation pane, choose Identities > Users. On the Users page, click Create User.</br>2. On the Create User page, enter a logon name and select OpenAPI Access for the Access Mode parameter.</br>3. After the RAM user is created, save the AccessKey pair. Then, find the user that you created on the Users page and click Add Permissions in the Actions column. In the Grant Permission panel, find the AdministratorAccess policy and attach it to the RAM user.</br>4. In a program, replace the AccessKey pair of the Alibaba Cloud account with the AccessKey pair of the RAM user created in the previous step and check whether the program runs as expected in the test environment.</br>5. If the program runs as expected, publish the program to the production environment and disable the previous AccessKey pair of your Alibaba Cloud account. Then, check whether the program runs as expected.</br>6. If the program runs as expected, delete the disabled AccessKey pair after the specified period of time, such as 90 days.\\",\\n \\"Title\\": \\"Scenario 3: AccessKey pair that is used within the last 90 days\\"\\n }\\n ],\\n \\"Notice\\": \\"This governance item enables the Best Practices for AccessKey and Permission Governance compliance package in Cloud Config to check the settings and usage of AccessKey pairs, Alibaba Cloud accounts, and RAM users.\\",\\n \\"Suggestion\\": \\"Console logon is enabled for the RAM user and the RAM user owns an AccessKey pair, while the AccessKey pair has never been used by the RAM user. We recommend that you disable the AccessKey pair for 90 days. If no related issue occurs during this period, you can delete the AccessKey pair.\\"\\n }\\n ],\\n \\"RemediationType\\": \\"Manual\\"\\n }\\n ]\\n },\\n \\"ResourceMetadata\\": {\\n \\"ResourcePropertyMetadata\\": [\\n {\\n \\"DisplayName\\": \\"Last time the AccessKey pair was used\\",\\n \\"PropertyName\\": \\"AkLastUsedTime\\",\\n \\"PropertyType\\": \\"String\\"\\n }\\n ]\\n },\\n \\"Scope\\": \\"Account\\",\\n \\"Stage\\": \\"Released\\",\\n \\"TopicCode\\": \\"ResourceUtilization\\"\\n }\\n ],\\n \\"Type\\": \\"Metric\\"\\n }\\n ],\\n \\"RequestId\\": \\"16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1\\"\\n}","type":"json"}]',
],
'ListEvaluationMetricDetails' => [
'summary' => '获取指定检测项的不合规资源信息，包含不合规资源的名称、ID、类别、类型、地域以及相关元数据。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2516,97 +1505,59 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceMBMBHG',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceMBMBHG'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '需要获取不合规资源的检测项ID。'."\n"
- ."\n"
- .'您可以调用[ListEvaluationMetadata](~~2841889~~)接口，获取检测项ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xfyve5****',
- ],
+ 'schema' => ['description' => '需要获取不合规资源的检测项ID。'."\n"
+ ."\n"
+ .'您可以调用[ListEvaluationMetadata](~~2841889~~)接口，获取检测项ID。', 'type' => 'string', 'required' => false, 'example' => 'xfyve5****'],
],
[
'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '成员账号ID。该参数仅适用于多账号检测模式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '103144549568****',
- ],
+ 'schema' => ['description' => '成员账号ID。该参数仅适用于多账号检测模式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '103144549568****'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****',
- ],
+ 'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '单次请求返回结果的最大条数。默认值：5。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['description' => '单次请求返回结果的最大条数。默认值：5。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SnapshotId',
'in' => 'query',
- 'schema' => [
- 'description' => '检测快照ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'es-bp1r**************',
- ],
+ 'schema' => ['description' => '检测快照ID。', 'type' => 'string', 'required' => false, 'example' => 'es-bp1r**************'],
],
[
'name' => 'Scope',
'in' => 'query',
- 'schema' => [
- 'description' => '治理成熟度检测范围。取值：'."\n"
- ."\n"
- .'- Account（默认）：查询当前账号的检测项明细。'."\n"
- .'- ResourceDirectory：查询资源目录所有成员账号的检测项明细。操作前，需要先升级至多账号治理成熟度检测。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Account',
- ],
+ 'schema' => ['description' => '治理成熟度检测范围。取值：'."\n"
+ ."\n"
+ .'- Account（默认）：查询当前账号的检测项明细。'."\n"
+ .'- ResourceDirectory：查询资源目录所有成员账号的检测项明细。操作前，需要先升级至多账号治理成熟度检测。', 'type' => 'string', 'required' => false, 'example' => 'Account'],
],
[
'name' => 'Date',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '查询的日期。', 'type' => 'string', 'required' => false, 'example' => '2026-01-01'],
+ ],
+ [
+ 'name' => 'EvaluationDomain',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -2616,17 +1567,8 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '用于获取下一页数据的令牌。',
- 'type' => 'string',
- 'example' => 'AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AC9BD94C-D20C-4D27-88D4-89E8D75C****',
- ],
+ 'NextToken' => ['description' => '用于获取下一页数据的令牌。', 'type' => 'string', 'example' => 'AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AC9BD94C-D20C-4D27-88D4-89E8D75C****'],
'Resources' => [
'description' => '不合规资源详情。',
'type' => 'array',
@@ -2634,38 +1576,13 @@
'description' => '不合规资源详情。',
'type' => 'object',
'properties' => [
- 'RegionId' => [
- 'title' => '资源所属 region',
- 'description' => '资源所属的地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ResourceClassification' => [
- 'description' => '辅助决策分类。'."\n"
- ."\n"
- .'> 只有支持辅助决策的检测项，才会返回该参数。',
- 'type' => 'string',
- 'example' => 'RecentUnloginRamUser',
- ],
- 'ResourceId' => [
- 'title' => '资源 id',
- 'description' => '资源ID。',
- 'type' => 'string',
- 'example' => '26435103783237****',
- ],
- 'ResourceName' => [
- 'title' => '资源名称',
- 'description' => '资源名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ResourceOwnerId' => [
- 'title' => '账号 id',
- 'description' => '资源所属的阿里云账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '176618589410****',
- ],
+ 'RegionId' => ['title' => '资源所属 region', 'description' => '资源所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'ResourceClassification' => ['description' => '辅助决策分类。'."\n"
+ ."\n"
+ .'> 只有支持辅助决策的检测项，才会返回该参数。', 'type' => 'string', 'example' => 'RecentUnloginRamUser'],
+ 'ResourceId' => ['title' => '资源 id', 'description' => '资源ID。', 'type' => 'string', 'example' => '26435103783237****'],
+ 'ResourceName' => ['title' => '资源名称', 'description' => '资源名称。', 'type' => 'string', 'example' => 'test'],
+ 'ResourceOwnerId' => ['title' => '账号 id', 'description' => '资源所属的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '176618589410****'],
'ResourceProperties' => [
'description' => '资源额外属性列表。',
'type' => 'array',
@@ -2673,73 +1590,65 @@
'description' => '资源额外属性列表。',
'type' => 'object',
'properties' => [
- 'PropertyName' => [
- 'description' => '资源属性的名称。',
- 'type' => 'string',
- 'example' => 'DisplayName',
- ],
- 'PropertyValue' => [
- 'description' => '资源属性的值。',
- 'type' => 'string',
- 'example' => 'TestAccount',
- ],
+ 'PropertyName' => ['description' => '资源属性的名称。', 'type' => 'string', 'example' => 'DisplayName'],
+ 'PropertyValue' => ['description' => '资源属性的值。', 'type' => 'string', 'example' => 'TestAccount'],
],
],
],
- 'ResourceType' => [
- 'title' => '资源类型',
- 'description' => '资源类型。',
- 'type' => 'string',
- 'example' => 'ACS::RAM::User',
- ],
- 'ComplianceType' => [
- 'description' => '合规状态。取值：'."\n"
- .'- NonCompliant：不合规。'."\n"
- .'- Excluded：已忽略。'."\n"
- .'- PendingExclusion：已忽略未生效。'."\n"
- .'- PendingInclusion：已取消忽略未生效。',
- 'type' => 'string',
- 'example' => 'NonCompliant',
- ],
+ 'ResourceType' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'example' => 'ACS::RAM::User'],
+ 'ComplianceType' => ['description' => '合规状态。取值：'."\n"
+ .'- NonCompliant：不合规。'."\n"
+ .'- Excluded：已忽略。'."\n"
+ .'- PendingExclusion：已忽略未生效。'."\n"
+ .'- PendingInclusion：已取消忽略未生效。', 'type' => 'string', 'example' => 'NonCompliant'],
],
],
],
- 'Date' => [
- 'type' => 'string',
- ],
+ 'Date' => ['description' => '日期。', 'type' => 'string', 'example' => '2026-01-01'],
],
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****\\",\\n \\"RequestId\\": \\"AC9BD94C-D20C-4D27-88D4-89E8D75C****\\",\\n \\"Resources\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceClassification\\": \\"RecentUnloginRamUser\\",\\n \\"ResourceId\\": \\"26435103783237****\\",\\n \\"ResourceName\\": \\"test\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceProperties\\": [\\n {\\n \\"PropertyName\\": \\"DisplayName\\",\\n \\"PropertyValue\\": \\"TestAccount\\"\\n }\\n ],\\n \\"ResourceType\\": \\"ACS::RAM::User\\",\\n \\"ComplianceType\\": \\"NonCompliant\\"\\n }\\n ],\\n \\"Date\\": \\"\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取指定检测项的不合规资源信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-11T06:08:45.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-10T06:35:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-27T03:04:35.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationMetricDetails'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationMetricDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****\\",\\n \\"RequestId\\": \\"AC9BD94C-D20C-4D27-88D4-89E8D75C****\\",\\n \\"Resources\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceClassification\\": \\"RecentUnloginRamUser\\",\\n \\"ResourceId\\": \\"26435103783237****\\",\\n \\"ResourceName\\": \\"test\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceProperties\\": [\\n {\\n \\"PropertyName\\": \\"DisplayName\\",\\n \\"PropertyValue\\": \\"TestAccount\\"\\n }\\n ],\\n \\"ResourceType\\": \\"ACS::RAM::User\\",\\n \\"ComplianceType\\": \\"NonCompliant\\"\\n }\\n ],\\n \\"Date\\": \\"2026-01-01\\"\\n}","type":"json"}]',
],
'ListEvaluationResults' => [
'summary' => '获取治理检测结果和状态。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2751,33 +1660,19 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceMBMBHG',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceMBMBHG'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '成员账号ID。该参数仅适用于多账号检测模式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '176618589410****',
- ],
+ 'schema' => ['description' => '成员账号ID。该参数仅适用于多账号检测模式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '176618589410****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Filters',
@@ -2790,25 +1685,15 @@
'description' => '过滤条件。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '过滤条件键。取值：'."\n"
- ."\n"
- .'- ResourceId：资源ID。'."\n"
- .'- ResourceName：资源名称。'."\n"
- .'- ResourceType：资源类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ResourceId',
- ],
+ 'Key' => ['description' => '过滤条件键。取值：'."\n"
+ ."\n"
+ .'- ResourceId：资源ID。'."\n"
+ .'- ResourceName：资源名称。'."\n"
+ .'- ResourceType：资源类型。', 'type' => 'string', 'required' => false, 'example' => 'ResourceId'],
'Values' => [
'description' => '过滤条件值列表。',
'type' => 'array',
- 'items' => [
- 'description' => '过滤条件值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c191**************b4f',
- ],
+ 'items' => ['description' => '过滤条件值。', 'type' => 'string', 'required' => false, 'example' => 'c191**************b4f'],
'required' => false,
],
],
@@ -2820,52 +1705,36 @@
[
'name' => 'SnapshotId',
'in' => 'query',
- 'schema' => [
- 'description' => '检测快照ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'es-bp1r**************',
- ],
+ 'schema' => ['description' => '检测快照ID。', 'type' => 'string', 'required' => false, 'example' => 'es-bp1r**************'],
],
[
'name' => 'Scope',
'in' => 'query',
- 'schema' => [
- 'description' => '治理成熟度检测范围。取值：'."\n"
- ."\n"
- .'- Account（默认）：执行单账号治理成熟度检测，仅检测当前账号。'."\n"
- .'- ResourceDirectory：执行多账号治理成熟度检测，即检测资源目录所有成员账号。操作前，需要先升级至多账号治理成熟度检测。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ResourceDirectory',
- ],
+ 'schema' => ['description' => '治理成熟度检测范围。取值：'."\n"
+ ."\n"
+ .'- Account（默认）：执行单账号治理成熟度检测，仅检测当前账号。'."\n"
+ .'- ResourceDirectory：执行多账号治理成熟度检测，即检测资源目录所有成员账号。操作前，需要先升级至多账号治理成熟度检测。', 'type' => 'string', 'required' => false, 'example' => 'ResourceDirectory'],
],
[
'name' => 'LensCode',
'in' => 'query',
- 'schema' => [
- 'description' => '专项检测代码。取值：'."\n"
- ."\n"
- .'- basic（默认）：基础模型（治理成熟度）检测。'."\n"
- .'- ack：容器构建专项检测。'."\n"
- .'- ai：机器学习专项检测。'."\n"
- .'- nis：网络服务专项检测。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'basic',
- ],
+ 'schema' => ['description' => '专项检测代码。取值：'."\n"
+ ."\n"
+ .'- basic（默认）：基础模型（治理成熟度）检测。'."\n"
+ .'- ack：容器构建专项检测。'."\n"
+ .'- ai：机器学习专项检测。'."\n"
+ .'- nis：网络服务专项检测。', 'type' => 'string', 'required' => false, 'example' => 'basic'],
],
[
'name' => 'TopicCode',
'in' => 'query',
'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '治理专题code',
- 'description' => '治理专题code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'IdentityAndAccessManagement',
- ],
+ 'schema' => ['title' => '治理专题code', 'description' => '治理专题code', 'type' => 'string', 'required' => false, 'example' => 'IdentityAndAccessManagement'],
+ ],
+ [
+ 'name' => 'EvaluationDomain',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -2875,27 +1744,13 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'AccountId' => [
- 'description' => '成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '176618589410****',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'BD57329E-131A-59F4-8746-E1CD8D7B****',
- ],
+ 'AccountId' => ['description' => '成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '176618589410****'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BD57329E-131A-59F4-8746-E1CD8D7B****'],
'Results' => [
'description' => '检测结果，包含整体检测状态以及子项检测结果。',
'type' => 'object',
'properties' => [
- 'EvaluationTime' => [
- 'description' => '整体检测结束时间（UTC时间）。',
- 'type' => 'string',
- 'example' => '2023-12-13T03:35:00Z'."\n",
- ],
+ 'EvaluationTime' => ['description' => '整体检测结束时间（UTC时间）。', 'type' => 'string', 'example' => '2023-12-13T03:35:00Z'."\n"],
'MetricResults' => [
'description' => '检测结果。',
'type' => 'array',
@@ -2909,114 +1764,58 @@
.'> 当`Status`为`Failed`时，返回该错误信息。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '错误码。'."\n",
- 'type' => 'string',
- 'example' => 'EcsInsightEnableFailed',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Unable to enable ECS Insight due to a server error.',
- ],
+ 'Code' => ['description' => '错误码。'."\n", 'type' => 'string', 'example' => 'EcsInsightEnableFailed'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Unable to enable ECS Insight due to a server error.'],
],
],
- 'EvaluationTime' => [
- 'description' => '单个检测项检测结束时间（UTC时间）。',
- 'type' => 'string',
- 'example' => '2023-12-13T03:34:02Z',
- ],
- 'Id' => [
- 'description' => '检测项ID。',
- 'type' => 'string',
- 'example' => 'r7xdcu****',
- ],
+ 'EvaluationTime' => ['description' => '单个检测项检测结束时间（UTC时间）。', 'type' => 'string', 'example' => '2023-12-13T03:34:02Z'],
+ 'Id' => ['description' => '检测项ID。', 'type' => 'string', 'example' => 'r7xdcu****'],
'ResourcesSummary' => [
'description' => '检测项资源评估汇总。',
'type' => 'object',
'properties' => [
- 'NonCompliant' => [
- 'description' => '不合规资源数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'NonCompliant' => ['description' => '不合规资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
- 'Result' => [
- 'description' => '检测项资源合规率。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.67',
- ],
- 'Risk' => [
- 'description' => '检测风险等级。取值：'."\n"
- ."\n"
- .'- Error：高风险。'."\n"
- .'- Warning：中风险。'."\n"
- .'- None：无风险。',
- 'type' => 'string',
- 'example' => 'Error',
- ],
- 'Status' => [
- 'description' => '单个检测项检测状态。取值：'."\n"
- ."\n"
- .'- Running：正在检测。'."\n"
- .'- Finished：检测完成。'."\n"
- .'- Failed：检测失败。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
+ 'Result' => ['description' => '检测项资源合规率。', 'type' => 'number', 'format' => 'double', 'example' => '0.67'],
+ 'Risk' => ['description' => '检测风险等级。取值：'."\n"
+ ."\n"
+ .'- Error：高风险。'."\n"
+ .'- Warning：中风险。'."\n"
+ .'- None：无风险。', 'type' => 'string', 'example' => 'Error'],
+ 'Status' => ['description' => '单个检测项检测状态。取值：'."\n"
+ ."\n"
+ .'- Running：正在检测。'."\n"
+ .'- Finished：检测完成。'."\n"
+ .'- Failed：检测失败。', 'type' => 'string', 'example' => 'Running'],
'AccountSummary' => [
'description' => '检测项账号评估汇总。',
'type' => 'object',
'properties' => [
- 'NonCompliant' => [
- 'description' => '不合规账号数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'NonCompliant' => ['description' => '不合规账号数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
- 'PotentialScoreIncrease' => [
- 'title' => '潜在分数提升',
- 'description' => '潜在分数提升',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.2',
- ],
+ 'PotentialScoreIncrease' => ['title' => '潜在分数提升', 'description' => '潜在分数提升', 'type' => 'number', 'format' => 'double', 'example' => '0.2'],
'AvailableRemediation' => [
'description' => '可用的修复列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'RemediationTemplateId' => [
- 'description' => '修正模板ID。',
- 'type' => 'string',
- ],
+ 'RemediationTemplateId' => ['description' => '修正模板ID。', 'type' => 'string'],
],
+ 'description' => '',
],
],
],
],
],
- 'Status' => [
- 'description' => '整体检测状态。取值：'."\n"
- ."\n"
- .'- Running：正在检测。'."\n"
- .'- Finished：检测完成。'."\n"
- .'- Failed：检测失败。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'TotalScore' => [
- 'description' => '总体分数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.6453',
- ],
+ 'Status' => ['description' => '整体检测状态。取值：'."\n"
+ ."\n"
+ .'- Running：正在检测。'."\n"
+ .'- Finished：检测完成。'."\n"
+ .'- Failed：检测失败。', 'type' => 'string', 'example' => 'Running'],
+ 'TotalScore' => ['description' => '总体分数。', 'type' => 'number', 'format' => 'double', 'example' => '0.6453'],
],
],
],
@@ -3025,34 +1824,157 @@
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidEnterpriseRealName.NotFound',
- 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.',
- ],
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取治理检测结果和状态',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T04:52:11.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-11T06:08:45.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-04-10T06:35:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-06T08:48:18.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-11T02:34:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-11T02:10:07.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationResults'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationResults',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountId\\": 0,\\n \\"RequestId\\": \\"BD57329E-131A-59F4-8746-E1CD8D7B****\\",\\n \\"Results\\": {\\n \\"EvaluationTime\\": \\"2023-12-13T03:35:00Z\\\\n\\",\\n \\"MetricResults\\": [\\n {\\n \\"ErrorInfo\\": {\\n \\"Code\\": \\"EcsInsightEnableFailed\\",\\n \\"Message\\": \\"Unable to enable ECS Insight due to a server error.\\"\\n },\\n \\"EvaluationTime\\": \\"2023-12-13T03:34:02Z\\",\\n \\"Id\\": \\"r7xdcu****\\",\\n \\"ResourcesSummary\\": {\\n \\"NonCompliant\\": 2\\n },\\n \\"Result\\": 0.67,\\n \\"Risk\\": \\"Error\\",\\n \\"Status\\": \\"Running\\",\\n \\"AccountSummary\\": {\\n \\"NonCompliant\\": 1\\n },\\n \\"PotentialScoreIncrease\\": 0.2,\\n \\"AvailableRemediation\\": [\\n {\\n \\"RemediationTemplateId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"Status\\": \\"Running\\",\\n \\"TotalScore\\": 0.6453\\n }\\n}","type":"json"}]',
- 'title' => '获取治理检测结果和状态',
],
- 'GenerateEvaluationReport' => [
- 'summary' => '生成治理检测报告',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ 'ListEvaluationScoreHistory' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceVMJHAB'],
+ 'tenantRelevance' => 'publicInformation',
],
- 'schemes' => [
- 'https',
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询的开始时间，格式：YYYY-MM-DD。'."\n"
+ ."\n"
+ .'最多查询最近180天的记录。', 'type' => 'string', 'required' => false, 'example' => '2024-06-11'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询的结束时间，格式：YYYY-MM-DD。'."\n"
+ ."\n"
+ .'默认为查询当前日期前7天的历史分数。', 'type' => 'string', 'required' => false, 'example' => '2024-07-11'],
+ ],
+ [
+ 'name' => 'AccountId',
+ 'in' => 'query',
+ 'schema' => ['description' => '成员账号ID。该参数仅适用于多账号检测模式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '176618589410****'],
+ ],
+ [
+ 'name' => 'EvaluationDomain',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ResponseBaseResult<ListEvaluationScoreHistoryResponse>',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AC9BD94C-D20C-4D27-88D4-89E8D75C051B'],
+ 'ScoreHistory' => [
+ 'description' => '历史检测分数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalScoreHistory' => [
+ 'description' => '历史检测分数。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '历史检测分数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EvaluationTime' => ['description' => '分数生成时间（UTC时间）。', 'type' => 'string', 'example' => '2024-06-30T03:34:02Z'],
+ 'Score' => ['description' => '分数。'."\n"
+ ."\n"
+ .'取值范围：0~1。', 'type' => 'number', 'format' => 'double', 'example' => '0.6753'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取治理检测历史分数',
+ 'summary' => '获取治理检测历史分数。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationScoreHistory'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationScoreHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC9BD94C-D20C-4D27-88D4-89E8D75C051B\\",\\n \\"ScoreHistory\\": {\\n \\"TotalScoreHistory\\": [\\n {\\n \\"EvaluationTime\\": \\"2024-06-30T03:34:02Z\\",\\n \\"Score\\": 0.6753\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'RunEvaluation' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3064,153 +1986,524 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernance9GNJ07',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceMBMBHG'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'AccountId',
+ 'in' => 'query',
+ 'schema' => ['description' => '成员账号ID。该参数仅适用于多账号检测模式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '176618589410****'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => 'RegionId',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'AccountId',
+ 'name' => 'Scope',
'in' => 'query',
+ 'schema' => ['description' => '治理成熟度检测范围。取值：'."\n"
+ ."\n"
+ .'- Account（默认）：运行单账号治理成熟度检测，仅检测当前账号。'."\n"
+ .'- ResourceDirectory：运行多账号治理成熟度检测，即检测资源目录所有成员账号。操作前，需要先升级至多账号治理成熟度检测。', 'type' => 'string', 'required' => false, 'example' => 'ResourceDirectory'],
+ ],
+ [
+ 'name' => 'MetricIds',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '账号ID，若不传入，默认生成当前账号的报告，MA账号可以传入成员账号的ID生成成员账号的报告。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '需要检测的检测项ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '检测项ID。', 'type' => 'string', 'required' => false, 'example' => 'xfyve5****'],
'required' => false,
- 'example' => '103144549568****',
],
],
[
- 'name' => 'ReportType',
+ 'name' => 'EvaluationDomain',
'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '报告类型。取值类型：'."\n"
- .'- EvaluationAccountHtmlReport：单账号HTML报告。'."\n"
- .'- EvaluationAccountExcelReport：单账号EXCEL报告。'."\n"
- .'- EvaluationMultiAccountExcelReport：多账号EXCEL报告。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'EvaluationAccountExcelReport',
- 'enum' => [
- 'EvaluationAccountReport',
- 'EvaluationAccountExcelReport',
- 'EvaluationMultiAccountExcelReport',
- 'EvaluationAccountHtmlReport',
+ 'title' => 'ResponseBaseResult<RunEvaluationResponse>',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '2D3E2A3A-F2B8-578D-9659-3195F94A****'],
],
],
],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '运行治理检测',
+ 'summary' => '运行云治理中心治理检测。',
+ 'changeSet' => [
+ ['createdAt' => '2024-11-14T09:32:13.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunEvaluation'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'AccountIds',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'governance:RunEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D3E2A3A-F2B8-578D-9659-3195F94A****\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateAccountFactoryBaseline' => [
+ 'summary' => '更新账号工厂基线。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => '基线ID。', 'type' => 'string', 'required' => false, 'example' => 'afb-bp1pq3emlkt27vsj****'],
+ ],
+ [
+ 'name' => 'BaselineName',
+ 'in' => 'query',
+ 'schema' => ['description' => '基线名称。', 'type' => 'string', 'required' => false, 'example' => 'Custom baseline'],
+ ],
+ [
+ 'name' => 'BaselineItems',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '生成报告的成员账号ID列表。'."\n"
- .'说明：仅在您生成多账号报告时，且希望生成指定账号范围的报告，才需要传入该参数。',
+ 'description' => '基线项列表。'."\n"
+ ."\n"
+ .'您可以调用[ListAccountFactoryBaselineItems](~~ListAccountFactoryBaselineItems~~)，获取云治理中心支持的账号工厂基线项列表。',
'type' => 'array',
'items' => [
- 'description' => '账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '基线项配置。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Config' => ['description' => '基线项配置。格式为JSON字符串。'."\n", 'type' => 'string', 'required' => false, 'example' => '{"EnabledServices":["CEN_TR","CDT","CMS","KMS"]}'],
+ 'Name' => ['description' => '基线项名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'."\n"],
+ 'Version' => ['description' => '基线项版本。'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0'."\n", 'default' => '1.0'],
+ ],
'required' => false,
- 'example' => '1319994761488600',
],
'required' => false,
],
],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '基线描述。', 'type' => 'string', 'required' => false, 'example' => 'Default baseline'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'ResponseBaseResult<Void>',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'AccountId' => [
- 'description' => '生成报告的账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '103144549568****',
- ],
- 'EvaluationScore' => [
- 'description' => '治理成熟度检测分数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.7684',
- ],
- 'EvaluationTime' => [
- 'description' => '检测时间。',
- 'type' => 'string',
- 'example' => '2026-01-12T07:25:33Z',
- ],
- 'Finished' => [
- 'description' => '报告是否生成完毕。'."\n"
- ."\n"
- .'> - true：报告生成完毕'."\n"
- .'> - false：报告未生成完毕',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ReportType' => [
- 'description' => '报告类型。返回值类型：'."\n"
- .'- EvaluationAccountHtmlReport：单账号HTML报告。'."\n"
- .'- EvaluationAccountExcelReport：单账号EXCEL报告。'."\n"
- .'- EvaluationMultiAccountExcelReport：多账号EXCEL报告。',
- 'type' => 'string',
- 'example' => 'EvaluationAccountExcelReport',
- ],
- 'ReportUrl' => [
- 'description' => '报告的下载地址。',
- 'type' => 'string',
- 'example' => 'https://governance-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/reports-html/*****',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '7DCF863F-CBBB-57C4-8AF2-5D4EE35D1EB1',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C18A891D-7B04-51A1-AAC6-201727A361CE'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidEnterpriseRealName.NotFound', 'errorMessage' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '系统错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C18A891D-7B04-51A1-AAC6-201727A361CE\\"\\n}","type":"json"}]',
+ 'title' => '更新账号工厂基线',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccountFactoryBaseline'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'governance:UpdateAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountId\\": 0,\\n \\"EvaluationScore\\": 0.7684,\\n \\"EvaluationTime\\": \\"2026-01-12T07:25:33Z\\",\\n \\"Finished\\": \\"true\\",\\n \\"ReportType\\": \\"EvaluationAccountExcelReport\\",\\n \\"ReportUrl\\": \\"https://governance-prod-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/reports-html/*****\\",\\n \\"RequestId\\": \\"7DCF863F-CBBB-57C4-8AF2-5D4EE35D1EB1\\"\\n}","type":"json"}]',
- 'title' => '生成治理检测报告',
- 'description' => '生成治理检测报告'."\n"
- .'> '."\n"
- .'> - 该接口为异步接口，通过返回值`Finished`字段判断报告生成情况。'."\n",
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'governance.ap-southeast-1.aliyuncs.com', 'endpoint' => 'governance.ap-southeast-1.aliyuncs.com', 'vpc' => 'governance-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'governance.cn-hangzhou.aliyuncs.com', 'endpoint' => 'governance.cn-hangzhou.aliyuncs.com', 'vpc' => 'governance-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'governance.eu-central-1.aliyuncs.com', 'endpoint' => 'governance.eu-central-1.aliyuncs.com', 'vpc' => 'governance-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'governance.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'governance.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'governance-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'BusinessRestricted', 'message' => 'Business is restricted. Please contact your customer service manager.', 'http_code' => 400, 'description' => '业务限制，请联系服务经理。'],
+ ['code' => 'DependencyViolation.BaselineItem', 'message' => 'The dependency of %s baseline item has not been configured. Please config %s first.', 'http_code' => 400, 'description' => '您还没有配置相关依赖的基线项，请先完成依赖基线项的配置。'],
+ ['code' => 'DependencyViolation.Blueprint', 'message' => 'The %s blueprint has not been deployed. Please deploy the resource structure first.', 'http_code' => 400, 'description' => '您还没有实施相关依赖的蓝图，请先完成依赖蓝图的实施。'],
+ ['code' => 'DeployConflict.Blueprint', 'message' => 'The %s blueprint is being deployed. Please wait for its deployment to complete and try again.', 'http_code' => 400, 'description' => '您有正在实施的蓝图，请等待其实施完成后重试。'],
+ ['code' => 'ExclusiveBlueprint.SSO', 'message' => 'CloudSSO and Role-Based SSO are mutually exclusive.', 'http_code' => 400, 'description' => 'CloudSSO 和 Role-Based SSO 互斥，请使用其中一种 SSO 管理方式'],
+ ['code' => 'Forbidden.Administrator', 'message' => 'The specified account does not have the administrator permission. We recommend that you log on using an administrator account.', 'http_code' => 403, 'description' => '请使用具有 Administrator 权限的用户登录云治理中心'],
+ ['code' => 'Forbidden.DisableAuditArchive', 'message' => 'This operation is forbidden. The specified user is not your log archive account.', 'http_code' => 403, 'description' => '禁止操作非日志账号'],
+ ['code' => 'InconsistentEnterpriseNameError', 'message' => 'The enterprise name of the payment account and the member account must be consistent.', 'http_code' => 400, 'description' => '财务账号与托管子账号企业实名信息不一致。'],
+ ['code' => 'IncorrectBlueprintStatus', 'message' => 'The current status of the blueprint does not support this operation.', 'http_code' => 400, 'description' => '蓝图当前状态不支持该操作，请稍后重试。'],
+ ['code' => 'IncorrectEvaluationTaskStatus', 'message' => 'The current status of the evaluation task does not support this operation.', 'http_code' => 400, 'description' => '当前检测状态不支持该操作'],
+ ['code' => 'IncorrectResourceDirectorySyncTaskStatus', 'message' => 'The current status of the resource directory sync task does not support this operation.', 'http_code' => 400, 'description' => '资源目录同步任务状态不支持该操作，请稍后重试'],
+ ['code' => 'InternalError', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => '系统错误。'],
+ ['code' => 'InvalidAggregator.NotFound', 'message' => 'The specified config aggregator does not exist.', 'http_code' => 404, 'description' => '配置审计账号组不存在'],
+ ['code' => 'InvalidBaseline.NotFound', 'message' => 'The specified baseline does not exist.', 'http_code' => 404, 'description' => '指定的账号基线不存在。'],
+ ['code' => 'InvalidBaselineItem.NotFound', 'message' => 'The specified baseline item named %s does not exist.', 'http_code' => 404, 'description' => '指定的基线项不存在。'],
+ ['code' => 'InvalidBlueprint.Existed', 'message' => 'The specified blueprint already exists.', 'http_code' => 400, 'description' => '蓝图实例已经存在。'],
+ ['code' => 'InvalidBlueprint.NotFound', 'message' => 'The specified blueprint does not exist.', 'http_code' => 404, 'description' => '蓝图实例不存在。'],
+ ['code' => 'InvalidEnterpriseRealName.NotFound', 'message' => 'The specified account has not passed enterprise real name verification. Please complete the verification for the account first.', 'http_code' => 404, 'description' => '当前账号未进行企业实名认证，请您先完成企业实名认证。'],
+ ['code' => 'InvalidEvaluation.Scope', 'message' => 'The specified evaluation scope does not support this action.', 'http_code' => 400, 'description' => '当前治理检测开启的范围不支持该操作'],
+ ['code' => 'InvalidGuardrail.NotFound', 'message' => 'The specified guardrail does not exist.', 'http_code' => 404, 'description' => '防护规则不存在'],
+ ['code' => 'InvalidIamRoleTemplate.NotFound', 'message' => 'The specified iam role template does not exist.', 'http_code' => 404, 'description' => '身份权限角色模板不存在'],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is not valid.', 'http_code' => 400, 'description' => '您的请求中存在参数缺失或者参数无效。'],
+ ['code' => 'InvalidParameter.Email.AlreadyUsed', 'message' => 'The email has been used.', 'http_code' => 400, 'description' => '邮箱已被使用'],
+ ['code' => 'InvalidRegion.NotMatch', 'message' => 'The speicified region is invalid. Please switch to your activated region %s.', 'http_code' => 403, 'description' => '当前地域无效，请切换地域，使用您开通时选择的地域。'],
+ ['code' => 'InvalidRole.NotFound', 'message' => 'The specified role %s does not exist.', 'http_code' => 404, 'description' => '角色不存在。'],
+ ['code' => 'InvalidSamlProvider.NotFound', 'message' => 'The specified saml provider does not exist.', 'http_code' => 404, 'description' => 'SSO身份提供商不存在'],
+ ['code' => 'InvalidUser.NotFound', 'message' => 'The specified user does not exist.', 'http_code' => 404, 'description' => '用户不存在。'],
+ ['code' => 'InvalidUser.NotInWhiteList', 'message' => 'Cloud Governance Center is at the public preview stage. Please apply for use by submitting a ticket.', 'http_code' => 400, 'description' => '云治理中心正在公测中，请联系您的客户经理申请公测资格。'],
+ ['code' => 'InvalidUser.NotResourceDirectoryMaster', 'message' => 'The specified account is not a master account of resource directory.', 'http_code' => 403, 'description' => '当前账号必须是资源目录的管理账号。'],
+ ['code' => 'InvalidUser.StatusAbnormal', 'message' => 'The status of your account is abnormal.', 'http_code' => 403, 'description' => '账号状态异常。'],
+ ['code' => 'InvalidUser.UnOpenService', 'message' => 'Your account has not activated Cloud Governance Center.', 'http_code' => 403, 'description' => '您的账号没有开通云治理中心。'],
+ ['code' => 'InvalidWorkload.NotFound', 'message' => 'The specified workload does not exist.', 'http_code' => 404, 'description' => '指定的工作负载不存在'],
+ ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation. Action: %s. Resource: %s.', 'http_code' => 403, 'description' => '当前账号没有权限执行该操作'],
+ ['code' => 'NoPermission.ResourceManager', 'message' => 'You are not authorized to perform this operation. Action: %s.', 'http_code' => 403, 'description' => '当前账号没有权限执行该操作。'],
+ ['code' => 'NoPermission.ServiceLinkedRole', 'message' => 'You are not authorized to create the service linked role. Service Name: %s. Please ensure the user has been granted the ram:CreateServiceLinkedRole permission', 'http_code' => 403, 'description' => '当前账号没有权限创建 service linked role，请确认其拥有 ram:CreateServiceLinkedRole 权限'],
+ ['code' => 'OperationDenied.ExistedBlueprint', 'message' => 'Specified operation is denied as there are still blueprint under this account.', 'http_code' => 400, 'description' => '当前账号下存在蓝图实例，不支持该操作。'],
+ ['code' => 'ResourceDirectory.NotOpen', 'message' => 'The specified account has not enabled resource directory.', 'http_code' => 400, 'description' => '当前账号未开通资源目录'],
+ ['code' => 'ResourceExplorerLimit.Exceed', 'message' => 'The maximum number of %s you listed is exceeded. The maximum value is %s.', 'http_code' => 400, 'description' => '查询数量超出最大限制'],
+ ['code' => 'InvalidConversation.NotFount', 'message' => 'The specified conversation does not exist or not belongs to the user.', 'http_code' => 404, 'description' => '该会话ID不存在或不属于当前用户'],
+ ['code' => 'InvalidConversation.NotFound', 'message' => 'The specified conversation does not exist or not belongs to the user.', 'http_code' => 404, 'description' => '当前会话不存在或会话不属于当前用户'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'governance.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetEnrolledAccount'],
+ ],
+ 'createdAt' => '2024-03-12T08:04:03.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'governance.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'EnrollAccount'],
+ ],
+ 'createdAt' => '2023-03-24T08:22:11.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'governance.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'EnrollAccount'],
+ ],
+ 'createdAt' => '2022-07-21T09:02:15.000Z',
+ 'description' => '账号工厂新增多基线功能',
],
[
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'governance.cn-shanghai-finance-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'EnrollAccount'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetEnrolledAccount'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListEnrolledAccounts'],
+ ],
+ 'createdAt' => '2022-05-26T07:10:54.000Z',
+ 'description' => '云治理中心账号工厂开放API',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchEnrollAccounts'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccountFactoryBaseline'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEnrolledAccount'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationMetadata'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunEvaluation'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccountFactoryBaselines'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationResults'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccountFactoryBaseline'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnrollAccount'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccountFactoryBaselineItems'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountFactoryBaseline'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccountFactoryBaseline'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnrolledAccounts'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationMetricDetails'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEvaluationScoreHistory'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Governance',
+ 'productName' => '云治理中心',
+ 'ramCodes' => ['governance'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [
+ [
+ 'name' => 'acs:ResourceGroupId',
+ 'schema' => ['type' => 'String', 'description' => '资源组Condition'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ListEvaluationMetricDetails',
+ 'description' => '获取指定检测项的不合规资源信息',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationMetricDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAccountFactoryBaseline',
+ 'description' => '获取账号工厂基线详情',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:GetAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEnrolledAccount',
+ 'description' => '获取账号工厂中注册账号详情',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:GetEnrolledAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEvaluationMetadata',
+ 'description' => '获取治理检测项信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationMetadata',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnrollAccount',
+ 'description' => '注册账号',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:EnrollAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEvaluationResults',
+ 'description' => '获取治理检测结果和状态',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationResults',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAccountFactoryBaseline',
+ 'description' => '创建账号工厂基线',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:CreateAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEvaluationScoreHistory',
+ 'description' => '获取治理检测历史分数',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:ListEvaluationScoreHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEnrolledAccounts',
+ 'description' => '获取账号工厂中注册账号的列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:ListEnrolledAccounts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchEnrollAccounts',
+ 'description' => '批量注册账号',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:BatchEnrollAccounts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunEvaluation',
+ 'description' => '运行治理检测',
+ 'operationType' => 'none',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:RunEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAccountFactoryBaseline',
+ 'description' => '删除账号工厂基线',
+ 'operationType' => 'delete',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:DeleteAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAccountFactoryBaselineItems',
+ 'description' => '获取账号工厂支持的基线项列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:ListAccountFactoryBaselineItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateEvaluationReport',
+ 'description' => '生成治理检测报告',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'governance:GenerateEvaluationReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAccountFactoryBaseline',
+ 'description' => '更新账号工厂基线',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'governance:UpdateAccountFactoryBaseline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAccountFactoryBaselines',
+ 'description' => '获取账号工厂基线列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'governance:ListAccountFactoryBaselines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Governance', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 19:03:26 +0000