From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/en_us/governance/2021-01-20/api-docs.php | 3177 +++++++++++++++++++++++++ 1 file changed, 3177 insertions(+) create mode 100644 data/en_us/governance/2021-01-20/api-docs.php (limited to 'data/en_us/governance/2021-01-20') diff --git a/data/en_us/governance/2021-01-20/api-docs.php b/data/en_us/governance/2021-01-20/api-docs.php new file mode 100644 index 0000000..2657444 --- /dev/null +++ b/data/en_us/governance/2021-01-20/api-docs.php @@ -0,0 +1,3177 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'governance', + 'version' => '2021-01-20', + ], + 'directories' => [ + [ + 'id' => 366159, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'EnrollAccount', + 'BatchEnrollAccounts', + 'ListEnrolledAccounts', + 'GetEnrolledAccount', + 'GetAccountFactoryBaseline', + 'ListAccountFactoryBaselines', + 'CreateAccountFactoryBaseline', + 'DeleteAccountFactoryBaseline', + 'ListAccountFactoryBaselineItems', + 'UpdateAccountFactoryBaseline', + ], + ], + [ + 'id' => 366170, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'RunEvaluation', + 'ListEvaluationMetadata', + 'ListEvaluationScoreHistory', + 'ListEvaluationMetricDetails', + 'ListEvaluationResults', + 'GenerateEvaluationReport', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'EnrollAccount' => [ + 'summary' => 'Enrolls an account. You can create a new account or manage an existing account in the account factory.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceUXLQGP', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccountNamePrefix', + 'in' => 'query', + 'schema' => [ + 'title' => '账号名称前缀', + 'description' => 'The prefix for the account name of the member.'."\n" + ."\n" + .'* If the account baseline is applied to an account that is newly created, you must configure this parameter.'."\n" + .'* If the account baseline is applied to an existing account, you do not need to configure this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-account', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => '账号显示名称', + 'description' => 'The display name of the account.'."\n" + ."\n" + .'* If the account baseline is applied to an account that is newly created, you must configure this parameter.'."\n" + .'* If the account baseline is applied to an existing account, you do not need to configure this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-account', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'title' => '父资源夹ID', + 'description' => 'The ID of the parent folder.'."\n" + ."\n" + .'* If the account baseline is applied to an account that is newly created, you need to specify a parent folder. If you do not configure this parameter, the account is created in the Root folder.'."\n" + .'* If the account baseline is applied to an existing account, you do not need to configure this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fd-5ESoku****', + ], + ], + [ + 'name' => 'PayerAccountUid', + 'in' => 'query', + 'schema' => [ + 'title' => '结算账号ID', + 'description' => 'The ID of the billing account.'."\n" + ."\n" + .'* If the account baseline is applied to an account that is newly created, you need to specify a billing account. If you do not configure this parameter, the self-pay settlement method is used for the account.'."\n" + .'* If the account baseline is applied to an existing account, you do not need to configure this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '19534534552****', + ], + ], + [ + 'name' => 'AccountUid', + 'in' => 'query', + 'schema' => [ + 'title' => '注册账号ID', + 'description' => 'The account ID.'."\n" + ."\n" + .'* If the account baseline is applied to an account that is newly created, you do not need to configure this parameter.'."\n" + .'* If the account baseline is applied to an existing account, you must configure this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12868156179****', + ], + ], + [ + 'name' => 'BaselineItems', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '基线项配置数组', + 'description' => 'The array that contains baseline items.'."\n" + ."\n" + .'If this parameter is specified, the configurations of the baseline items are merged with the baseline applied to the specified account. The configurations of the same baseline items are subject to the configurations of this parameter. We recommend that you leave this parameter empty and configure the `BaselineId` parameter to specify an account baseline and apply the configurations of the account baseline to the account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'title' => '基线项配置', + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}', + ], + 'Name' => [ + 'title' => '基线项名称', + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Skip' => [ + 'title' => '是否跳过基线项', + 'description' => 'Whether to skip the baseline item. Valid values:'."\n" + ."\n" + .'* false: The baseline item is not skipped.'."\n" + .'* true: The baseline item is skipped.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Version' => [ + 'title' => '基线项版本', + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + 'default' => '1.0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BaselineId', + 'in' => 'query', + 'schema' => [ + 'title' => '基线ID', + 'description' => 'The baseline ID.'."\n" + ."\n" + .'If this parameter is left empty, the default baseline is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'afb-bp1durvn3lgqe28v****', + ], + ], + [ + 'name' => 'ResellAccountType', + 'in' => 'query', + 'schema' => [ + 'title' => '账号身份类型', + 'description' => 'The identity type of the member. Valid values:'."\n" + ."\n" + .'* resell (default): The member is an account for a reseller. A relationship is automatically established between the member and the reseller. The management account of the resource directory must be used as the billing account of the member.'."\n" + .'* non_resell: The member is not an account for a reseller. The member is an account that is not associated with a reseller. You can directly use the account to purchase Alibaba Cloud resources. The member is used as its own billing account.'."\n" + ."\n" + .'> This parameter is available only for resellers at the international site (alibabacloud.com).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'resell', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags. You can specify up to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tagKey', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tagValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountUid' => [ + 'title' => '注册账号ID', + 'description' => 'The account ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '143165363236****', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7071E5FA-515E-5F53-B335-B87D619C6A66', + ], + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUser.NotResourceDirectoryMaster', + 'errorMessage' => 'The specified account is not a master account of resource directory.', + ], + ], + [ + [ + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountUid\\": 0,\\n \\"RequestId\\": \\"7071E5FA-515E-5F53-B335-B87D619C6A66\\"\\n}","type":"json"}]', + 'title' => 'EnrollAccount', + 'description' => 'You can call this API operation to create a new account or manage an existing account and apply the account baseline to the account.'."\n" + ."\n" + .'Accounts are created in asynchronous mode. After you create an account, you can apply the account baseline to the account. You can call the [GetEnrolledAccount API](~~GetEnrolledAccount~~) operation to view the details about the account to obtain the result of applying the account baseline to the account.'."\n", + ], + 'BatchEnrollAccounts' => [ + 'summary' => 'Applies an account baseline to multiple existing resource accounts at a time.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceUXLQGP', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Accounts', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resource account.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountUid' => [ + 'description' => 'The account ID. This parameter is required.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12868156179****'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BaselineItems', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The baseline items.'."\n" + ."\n" + .'If this parameter is specified, the configurations of the baseline items are merged with the baseline applied to the specified account. The configurations of the same baseline items are subject to the configurations of this parameter. We recommend that you leave this parameter empty and configure the `BaselineId` parameter to specify an account baseline and apply the configurations of the account baseline to the account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}', + ], + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Skip' => [ + 'description' => 'Specifies whether to skip the baseline item. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BaselineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The baseline ID.'."\n" + ."\n" + .'If this parameter is left empty, the default baseline is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'afb-bp1durvn3lgqe28v****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1\\"\\n}","type":"json"}]', + 'title' => 'BatchEnrollAccounts', + 'description' => 'You can call this operation to apply an account baseline to existing resource accounts.'."\n" + ."\n" + .'Accounts are enrolled in the account factory in asynchronous mode. After a resource account is created, an account baseline is applied to the account. You can call the [GetEnrolledAccount](~~609062~~) operation to query the details of the account enrolled in the account factory and check whether the account baseline is applied to the account.'."\n", + ], + 'ListEnrolledAccounts' => [ + 'summary' => 'Queries a list of accounts that are enrolled in the account factory.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceARZHCM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '查询返回结果下一页的令牌。首次调用API不需要NextToken', + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '每页的最大数据条数', + 'description' => 'The maximum number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + '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' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '注册账号列表', + 'description' => 'The created accounts.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnrolledAccounts' => [ + 'title' => '账号列表', + 'description' => 'The enrolled accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The account.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountUid' => [ + 'title' => '账号ID', + 'description' => 'The account ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19534534552*****', + ], + 'BaselineId' => [ + 'description' => 'The ID of the baseline that is implemented.'."\n", + 'type' => 'string', + 'example' => 'afb-bp1durvn3lgqe28v****', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2021-11-01T02:38:27Z', + ], + 'DisplayName' => [ + 'title' => '账号显示名称', + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'example' => 'TestAccount', + ], + 'FolderId' => [ + 'title' => '父资源夹ID', + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'example' => 'fd-5ESoku****', + ], + 'PayerAccountUid' => [ + 'title' => '结算账号ID', + 'description' => 'The ID of the settlement account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13161210500*****', + ], + 'Status' => [ + 'title' => '创建状态', + 'description' => 'The creation status. Valid values:'."\n" + ."\n" + .'* Pending: The account is pending to be created.'."\n" + .'* Running: The account is being created.'."\n" + .'* Finished: The account is created.'."\n" + .'* Failed: The account fails to be created.'."\n" + .'* Scheduling: The account is being scheduled.'."\n" + .'* ScheduleFailed: The account fails to be scheduled.'."\n", + 'type' => 'string', + 'example' => 'Running', + 'enum' => [], + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2021-11-01T02:38:27Z', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '查询返回结果下一页的令牌', + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '768F908D-A66A-5A5D-816C-20C93CBBFEE3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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":"\\n 768F908D-A66A-5A5D-816C-20C93CBBFEE3\\n AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****\\n \\n Running\\n 2021-11-01T02:38:27Z\\n TestAccount\\n fd-5ESoku****\\n 2021-11-01T02:38:27Z\\n 1234\\n 1234\\n \\n","errorExample":""}]', + 'title' => 'ListEnrolledAccounts', + ], + 'GetEnrolledAccount' => [ + 'summary' => 'Queries the details about an account that is enrolled in the account factory.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountUid', + 'in' => 'query', + 'schema' => [ + 'title' => '账号ID', + 'description' => 'The account ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '19534534552****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '注册账号信息', + 'description' => 'The information about the account.', + 'type' => 'object', + 'properties' => [ + 'AccountUid' => [ + 'title' => '账号ID', + 'description' => 'The account ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12868156179*****', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => 'The ID of the baseline that is implemented.'."\n", + 'type' => 'string', + 'example' => 'afb-bp1adadfadsf***', + ], + 'BaselineItems' => [ + 'description' => 'The array that contains baseline items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of the baseline item'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'The configuration of the baseline item.', + 'type' => 'string', + 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}', + ], + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Skip' => [ + 'description' => 'Indicates whether baseline item is skipped. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + ], + ], + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the account was created.'."\n", + 'type' => 'string', + 'example' => '2021-11-01T02:38:27Z', + ], + 'DisplayName' => [ + 'title' => '账号显示名称', + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'example' => 'test-account', + ], + 'ErrorInfo' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n" + ."\n" + .'> This parameter is returned if the value of `Status` is `Failed` or `ScheduleFailed`.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'CompliancePackExists', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The compliance pack already exists.'."\n", + ], + 'Recommend' => [ + 'title' => '错误处理建议', + 'description' => 'The recommended solution.'."\n", + 'type' => 'string', + 'example' => 'https://next.api.aliyun.com/troubleshoot?q=CompliancePackExists\\\\u0026product=Config'."\n", + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E', + ], + ], + ], + 'FolderId' => [ + 'title' => '父资源夹ID', + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'example' => 'fd-5ESoku****', + ], + 'Initialized' => [ + 'title' => '是否初始化完成', + 'description' => 'Indicates whether the initialization is complete. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Inputs' => [ + 'title' => '注册账号时的输入参数', + 'description' => 'Input parameters used to create an account.', + 'type' => 'object', + 'properties' => [ + 'AccountNamePrefix' => [ + 'title' => '账号名称前缀', + 'description' => 'The prefix of the account name.'."\n", + 'type' => 'string', + 'example' => 'test-account', + ], + 'AccountUid' => [ + 'title' => '账号ID', + 'description' => 'The account ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12868156179*****', + ], + 'BaselineItems' => [ + 'title' => '基线项配置数组', + 'description' => 'The baseline items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'title' => '基线项配置', + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'string', + 'example' => '{\\"Contacts\\":[{\\"Name\\":\\"governance\\",\\"Email\\":\\"wibud****@gmail.com\\",\\"Mobile\\":\\"1234\\",\\"Position\\":\\"Other\\"}]}', + ], + 'Name' => [ + 'title' => '基线项名称', + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Skip' => [ + 'title' => '是否跳过基线项', + 'description' => 'Indicates whether baseline item is skipped. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Version' => [ + 'title' => '基线项版本', + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + ], + ], + ], + 'DisplayName' => [ + 'title' => '账号展示名称', + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'example' => 'test-account', + ], + 'FolderId' => [ + 'title' => '父资源夹ID', + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'example' => 'fd-5ESoku****', + ], + 'PayerAccountUid' => [ + 'title' => '结算账号ID', + 'description' => 'The ID of the settlement account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19534534552*****', + ], + 'Tag' => [ + 'description' => 'The tag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'example' => 'product', + ], + 'Value' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'example' => 'governance', + ], + ], + ], + ], + ], + ], + 'MasterAccountUid' => [ + 'title' => '所属的Master账号ID', + 'description' => 'The ID of the management account of the resource directory to which the account belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19534534552*****', + ], + 'PayerAccountUid' => [ + 'title' => '结算账号ID', + 'description' => 'The ID of the settlement account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19534534552*****', + ], + 'Progress' => [ + 'title' => '基线实施进度', + 'description' => 'The progress of the applying the baseline to the account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The progress of applying the account baseline to the account.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '基线项名称', + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Status' => [ + 'title' => '基线项实施状态', + 'description' => 'The status of applying the baseline to the account. Valid values:'."\n" + ."\n" + .'* Pending: The baseline is pending to be applied to the account.'."\n" + .'* Running: The baseline is being applied to the account.'."\n" + .'* Finished: : The baseline is applied to the account.'."\n" + .'* Failed: : The baseline fails to be applied to the account.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '768F908D-A66A-5A5D-816C-20C93CBBFEE3', + ], + 'Status' => [ + 'title' => '账号注册状态', + 'description' => 'The status of the account. Valid values:'."\n" + ."\n" + .'* Pending: The account is pending to be created.'."\n" + .'* Running: The account is being created.'."\n" + .'* Finished: The account is created.'."\n" + .'* Failed: The account fails to be created.'."\n" + .'* Scheduling: The account is being scheduled.'."\n" + .'* ScheduleFailed: The account fails to be scheduled.'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => 'The update time.', + 'type' => 'string', + 'example' => '2021-11-01T02:38:27Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => 'GetEnrolledAccount', + ], + 'GetAccountFactoryBaseline' => [ + 'summary' => 'Obtains the details of an account factory baseline.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BaselineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The baseline ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'afb-bp1nf0enuzb89az*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The baseline configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'BaselineId' => [ + 'description' => 'The baseline ID.'."\n", + 'type' => 'string', + 'example' => 'afb-bp16ae2k8a3yo3d*****', + ], + 'BaselineItems' => [ + 'description' => 'The baseline items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'The configuration of the baseline item.'."\n" + ."\n" + .'The value is a JSON string.'."\n", + 'type' => 'string', + 'example' => '{\\"Notifications\\":[{\\"GroupKey\\":\\"account_msg\\",\\"Contacts\\":[{\\"Name\\":\\"aa\\"}],\\"PmsgStatus\\":1,\\"EmailStatus\\":1,\\"SmsStatus\\":1}]}', + ], + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'example' => '1097526274671790', + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + ], + ], + ], + 'BaselineName' => [ + 'description' => 'The name of the baseline.'."\n", + 'type' => 'string', + 'example' => 'Default', + 'default' => 'Default', + ], + 'CreateTime' => [ + 'description' => 'The time when the baseline was created.'."\n", + 'type' => 'string', + 'example' => '2022-11-28T00:46:34Z', + ], + 'Description' => [ + 'description' => 'The description of the baseline.'."\n", + 'type' => 'string', + 'example' => 'Default baseline', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '60D54503-F1F6-51B6-B6FA-A70CBDA2A68C', + ], + 'Type' => [ + 'description' => 'The type of the baseline. Valid values:'."\n" + ."\n" + .'* System: default baseline.'."\n" + .'* Custom: custom baseline.'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + 'UpdateTime' => [ + 'description' => 'The time when the baseline was updated.'."\n", + 'type' => 'string', + 'example' => '2022-11-02T01:00:07Z', + ], + ], + ], + ], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + '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\\": \\"默认基线\\",\\n \\"RequestId\\": \\"60D54503-F1F6-51B6-B6FA-A70CBDA2A68C\\",\\n \\"Type\\": \\"Custom\\",\\n \\"UpdateTime\\": \\"2022-11-02T01:00:07Z\\"\\n}","type":"json"}]', + 'title' => 'GetAccountFactoryBaseline', + ], + 'ListAccountFactoryBaselines' => [ + 'summary' => 'Obtains a list of baselines in the account factory.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceH3XRB0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return on each page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponsePageResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Baselines' => [ + 'description' => 'The baselines.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the baseline.', + 'type' => 'object', + 'properties' => [ + 'BaselineId' => [ + 'description' => 'The baseline ID.'."\n", + 'type' => 'string', + 'example' => 'afb-bp1durvn3lgqe28v****', + ], + 'BaselineName' => [ + 'description' => 'The name of the baseline.'."\n", + 'type' => 'string', + 'example' => 'Default', + ], + 'CreateTime' => [ + 'description' => 'The time at which the baseline was created.'."\n", + 'type' => 'string', + 'example' => '2021-11-30T09:09:28Z', + ], + 'Description' => [ + 'description' => 'The description of the baseline.'."\n", + 'type' => 'string', + 'example' => 'Default baseline'."\n", + ], + 'Type' => [ + 'description' => 'The type of the baseline. Valid values:'."\n" + ."\n" + .'* System: default baseline.'."\n" + .'* Custom: custom baseline.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Custom', + ], + 'UpdateTime' => [ + 'description' => 'The time when the baseline was updated.'."\n", + 'type' => 'string', + 'example' => '2022-12-29T07:08:40Z', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + '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"}]', + 'title' => 'ListAccountFactoryBaselines', + ], + 'CreateAccountFactoryBaseline' => [ + 'summary' => 'Creates a baseline of the account factory.', + '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' => 'The name of the baseline.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + 'default' => 'Default', + ], + ], + [ + 'name' => 'BaselineItems', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'An array that contains the baseline items.'."\n" + ."\n" + .'You can call the [ListAccountFactoryBaselineItems](~~ListAccountFactoryBaselineItems~~) operation to query a list of baseline items supported by the account factory in Cloud Governance Center.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'The configurations of the baseline item. The value of this parameter is a JSON string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"EnabledServices\\":[\\"CEN_TR\\",\\"CDT\\",\\"CMS\\",\\"KMS\\"]}', + ], + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + 'default' => '1.0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the baseline.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default Baseline.', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'BaselineId' => [ + 'description' => 'The baseline ID.'."\n", + 'type' => 'string', + 'example' => 'afb-bp1e6ixtiwupap8m****', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + 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' => 'CreateAccountFactoryBaseline', + ], + 'DeleteAccountFactoryBaseline' => [ + 'summary' => 'Deletes an account factory baseline.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BaselineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The baseline ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'afb-bp1durvn3lgqe28v****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0F45D888-8C4D-55E5-ACA2-D1515159181D', + ], + ], + ], + ], + ], + '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' => 'DeleteAccountFactoryBaseline', + ], + 'ListAccountFactoryBaselineItems' => [ + 'summary' => 'Queries a list of baseline items that are supported by the account factory of Cloud Governance Center (CGC).', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceARZHCM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the baseline items.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AccountFactory', + ], + ], + [ + 'name' => 'Names', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The names of the baseline items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Versions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The versions of the baseline items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponsePageResult', + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'BaselineItems' => [ + 'description' => 'The baseline items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'object', + 'properties' => [ + 'DependsOn' => [ + 'description' => 'The dependency of the baseline item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dependency configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC', + ], + 'Type' => [ + 'description' => 'The type of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'AccountFactory', + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + ], + ], + ], + 'Description' => [ + 'description' => 'The description of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'Notification.', + ], + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'ACS-BP_ACCOUNT_FACTORY_ACCOUNT_NOTIFICATION', + ], + 'Type' => [ + 'description' => 'The type of the baseline item.'."\n", + 'type' => 'string', + 'example' => 'AccountFactory', + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'AAAAACDGQdAEX3m42z3sQ+f3VTK2Xr2DzYbz/SAfc/zJRqod', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B40D73D8-76AC-5D3C-AC63-4FC8AFCE6671', + ], + ], + ], + ], + ], + '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' => 'ListAccountFactoryBaselineItems', + ], + 'UpdateAccountFactoryBaseline' => [ + 'summary' => 'Updates a baseline of the account factory.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BaselineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The baseline ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'afb-bp1pq3emlkt27vsj****', + ], + ], + [ + 'name' => 'BaselineName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the baseline.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'BaselineItems', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The baseline items.'."\n" + ."\n" + .'You can call the [ListAccountFactoryBaselineItems](~~ListAccountFactoryBaselineItems~~) operation to query a list of baseline items supported by the account factory in Cloud Governance Center.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the baseline item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'The configurations of the baseline item. The value of this parameter is a JSON string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"EnabledServices\\":[\\"CEN_TR\\",\\"CDT\\",\\"CMS\\",\\"KMS\\"]}'."\n", + ], + 'Name' => [ + 'description' => 'The name of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACS-BP_ACCOUNT_FACTORY_VPC'."\n", + ], + 'Version' => [ + 'description' => 'The version of the baseline item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0'."\n", + 'default' => '1.0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the baseline.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C18A891D-7B04-51A1-AAC6-201727A361CE', + ], + ], + ], + ], + ], + '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\\": \\"C18A891D-7B04-51A1-AAC6-201727A361CE\\"\\n}","type":"json"}]', + 'title' => 'UpdateAccountFactoryBaseline', + ], + 'RunEvaluation' => [ + 'summary' => 'Performs a governance maturity check.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceMBMBHG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member. This parameter takes effect only when a multi-account governance maturity check is performed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '176618589410****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The check range of the governance maturity check. Valid values:'."\n" + ."\n" + .'* Account (default): A single-account governance maturity check is performed to check only the Alibaba Cloud account that you use to access Cloud Governance Center.'."\n" + .'* ResourceDirectory: A multi-account governance maturity check is performed to check all members within a resource directory. Before you perform a multi-account governance maturity check, you must enable the multi-account governance maturity check feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceDirectory', + ], + ], + [ + 'name' => 'MetricIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the check items to be checked.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the check items.', + 'type' => 'string', + 'required' => false, + 'example' => 'xfyve5****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D3E2A3A-F2B8-578D-9659-3195F94A****\\"\\n}","type":"json"}]', + 'title' => 'RunEvaluation', + ], + 'ListEvaluationMetadata' => [ + 'summary' => 'Queries all available information about check items in a governance maturity check, including the name, ID, description, stage, resource metadata, and fixing guide.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceMBMBHG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language. The information is returned in the specified language. Valid values:'."\n" + ."\n" + .'* en: English'."\n" + .'* zh: Chinese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'LensCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TopicCode', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '治理专题code', + 'type' => 'string', + 'example' => 'ResourceUtilization', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EvaluationMetadata' => [ + 'description' => 'The metadata of a governance maturity check.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata of a governance maturity check.'."\n", + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'description' => 'The metadata objects of a specific metadata type.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata object of a specific metadata type.'."\n", + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => 'The category of the check item.'."\n", + 'type' => 'string', + 'example' => 'Security', + ], + 'Description' => [ + 'description' => 'The description of the check item.'."\n", + 'type' => 'string', + 'example' => 'If you use an AccessKey pair of an Alibaba Cloud account, you have full permissions on the resources of the account. You cannot set limits on the account, such as setting limits on source IP addresses or access duration. If the AccessKey pair is leaked, resources within the account are exposed to high security risks. If your Alibaba Cloud account has an existing AccessKey pair, the check result is Non-compliant.', + ], + 'DisplayName' => [ + 'description' => 'The display name of the check item.'."\n", + 'type' => 'string', + 'example' => 'An AccessKey pair is enabled for the Alibaba Cloud account.', + ], + 'Id' => [ + 'description' => 'The ID of the metadata.'."\n", + 'type' => 'string', + 'example' => 'pxgtda****', + ], + 'RecommendationLevel' => [ + 'description' => 'The governance level of the check item.'."\n", + 'type' => 'string', + 'example' => 'High', + ], + 'RemediationMetadata' => [ + 'description' => 'The metadata of the fixing task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Remediation' => [ + 'description' => 'The fixing items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The fixing item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Actions' => [ + 'description' => 'The fixing operations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The fixing operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Classification' => [ + 'description' => 'The fixing method.'."\n" + ."\n" + .'> This parameter is returned only if the value of `RemediationType` is `Analysis`.'."\n", + 'type' => 'string', + 'example' => 'UnusedAccessKeyInRamUser', + ], + 'CostDescription' => [ + 'description' => 'The fixing cost.'."\n", + 'type' => 'string', + 'example' => 'You are not charged for this operation.', + ], + 'Description' => [ + 'description' => 'The description of the fixing item.'."\n" + ."\n" + .'> This parameter is returned only if the value of `RemediationType` is `Analysis`.'."\n", + 'type' => 'string', + 'example' => 'Console logon is enabled for the RAM user. The RAM user owns an AccessKey pair that is never used.', + ], + 'Guidance' => [ + 'description' => 'The content of the fixing items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The content of a fixing item.'."\n", + 'type' => 'object', + 'properties' => [ + 'ButtonName' => [ + 'description' => 'The display name of the fixing button.'."\n", + 'type' => 'string', + 'example' => 'Manual fixing', + ], + 'ButtonRef' => [ + 'description' => 'The navigation URL of the fixing button.'."\n", + 'type' => 'string', + 'example' => 'https://ram.console.aliyun.com/users', + ], + 'Content' => [ + 'description' => 'The fixing procedure.'."\n", + 'type' => 'string', + 'example' => 'You must replace the AccessKey pair of your Alibaba Cloud account. To do so, perform the following steps:
1. Log on to the RAM console. In the left-side navigation pane, choose Identities > Users. On the Users page, click Create User.
2. On the Create User page, enter a logon name and select OpenAPI Access for the Access Mode parameter.
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.
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.
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.
6. If the program runs as expected, delete the disabled AccessKey pair after the specified period of time, such as 90 days.', + ], + 'Title' => [ + 'description' => 'The title of the fixing procedure.'."\n", + 'type' => 'string', + 'example' => 'Scenario 3: AccessKey pair that is used within the last 90 days', + ], + ], + ], + ], + 'Notice' => [ + 'description' => 'The usage notes of the fixing item.'."\n", + 'type' => 'string', + 'example' => 'The BestPracticesForIdentityAndPermissions compliance package is enabled in Cloud Config to check the settings and usage of the AccessKey pair, Alibaba Cloud account, and RAM users.', + ], + 'Suggestion' => [ + 'description' => 'The fixing suggestion.'."\n" + ."\n" + .'> This parameter is returned only if the value of `RemediationType` is `Analysis`.'."\n", + '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' => 'The type of the fixing method. Valid values:'."\n" + ."\n" + .'* Manual: manual fixing'."\n" + .'* QuickFix: quick fixing'."\n" + .'* Analysis: auxiliary decision-making'."\n", + 'type' => 'string', + 'example' => 'Manual', + ], + ], + ], + ], + ], + ], + 'ResourceMetadata' => [ + 'description' => 'The metadata of the checked resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourcePropertyMetadata' => [ + 'description' => 'The metadata of the resource properties.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata of the resource property.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the resource property.'."\n", + 'type' => 'string', + 'example' => 'AccessKey Pair Last Used At', + ], + 'PropertyName' => [ + 'description' => 'The name of the resource property.'."\n", + 'type' => 'string', + 'example' => 'AkLastUsedTime', + ], + 'PropertyType' => [ + 'description' => 'The type of the resource property.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + ], + ], + ], + ], + ], + 'Scope' => [ + 'description' => 'The scope of the check item. Valid values:'."\n" + ."\n" + .'* Account: the check item in a single-account governance maturity check'."\n" + .'* ResourceDirectory: the check item in a multi-account governance maturity check'."\n", + 'type' => 'string', + 'example' => 'Account', + ], + 'Stage' => [ + 'description' => 'The status of the check item. Valid values:'."\n" + ."\n" + .'* Released: The check item is released.'."\n" + .'* Beta: The check item is pre-released.'."\n", + 'type' => 'string', + 'example' => 'Released', + ], + 'TopicCode' => [ + 'title' => '所属治理专题code', + 'type' => 'string', + 'example' => 'ResourceUtilization', + ], + ], + ], + ], + 'Type' => [ + 'description' => 'The type of the metadata. Valid values:'."\n" + ."\n" + .'* Metric: the check item'."\n", + 'type' => 'string', + 'example' => 'Metric', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + ], + ], + '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\\": \\"需进行腾挪操作，步骤如下：
1. 进入 RAM 控制台，「身份管理」-「用户」，单击「创建用户」。
2. 填写「登录名称」，下方「访问方式」，勾选 OpenAPI 调用访问。
3. 创建成功后，保存该 RAM 用户的 AccessKey，勾选该 RAM 用户，单击「添加权限」，在弹出的侧边栏中，添加 AdministratorAccess权限。
4. 在程序中将主账号 AccessKey 替换为上步骤中创建的 RAM 用户 AccessKey，在相应的测试环境中验证程序逻辑是否正常。
5. 如果验证通过，将程序发布到生产环境，并将主账号 AccessKey 禁用，观察应用是否正常。
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"}]', + 'title' => 'ListEvaluationMetadata', + ], + 'ListEvaluationScoreHistory' => [ + 'summary' => 'Queries the historical scores of a governance maturity check.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceVMJHAB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the YYYY-MM-DD format.'."\n" + ."\n" + .'You can query the historical scores within the previous 180 days.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-06-11', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the YYYY-MM-DD format.'."\n" + ."\n" + .'By default, the historical scores that were generated in the seven days before the current date are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-07-11', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member. This parameter takes effect only when a multi-account governance maturity check is performed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '176618589410****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AC9BD94C-D20C-4D27-88D4-89E8D75C051B', + ], + 'ScoreHistory' => [ + 'description' => 'The historical scores.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalScoreHistory' => [ + 'description' => 'The historical scores.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The historical score.'."\n", + 'type' => 'object', + 'properties' => [ + 'EvaluationTime' => [ + 'description' => 'The time when the score was generated. The time is in UTC.'."\n", + 'type' => 'string', + 'example' => '2024-06-30T03:34:02Z', + ], + 'Score' => [ + 'description' => 'The score.'."\n" + ."\n" + .'Valid values: 0 to 1.'."\n", + '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.', + ], + ], + 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' => 'ListEvaluationScoreHistory', + ], + 'ListEvaluationMetricDetails' => [ + 'summary' => 'Queries the non-compliant resource information of a check item, including the name, ID, category, type, region, and related metadata of non-compliant resources.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceMBMBHG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the check item.'."\n" + ."\n" + .'You can call the [ListEvaluationMetadata](~~2841889~~) operation to query the ID of the check item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xfyve5****', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member. This parameter takes effect only when a multi-account governance maturity check is performed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '103144549568****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request. Default value: 5.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponsePageResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'AAAAAGEaXR18y1rqykZHIqRuBejOqED4S3Xne33c7zbn****', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AC9BD94C-D20C-4D27-88D4-89E8D75C****', + ], + 'Resources' => [ + 'description' => 'The details of the non-compliant resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the non-compliant resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => '资源所属 region', + 'description' => 'The region ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceClassification' => [ + 'description' => 'The check results further analyzed by auxiliary decision-making.'."\n" + ."\n" + .'> This parameter is returned only when the check item supports the auxiliary decision-making feature.'."\n", + 'type' => 'string', + 'example' => 'RecentUnloginRamUser', + ], + 'ResourceId' => [ + 'title' => '资源 id', + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => '26435103783237****', + ], + 'ResourceName' => [ + 'title' => '资源名称', + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceOwnerId' => [ + 'title' => '账号 id', + 'description' => 'The ID of the Alibaba Cloud account that owns the resource.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '176618589410****', + ], + 'ResourceProperties' => [ + 'description' => 'The attributes of the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute of the resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'PropertyName' => [ + 'description' => 'The name of the resource attribute.'."\n", + 'type' => 'string', + 'example' => 'DisplayName', + ], + 'PropertyValue' => [ + 'description' => 'The value of the resource attribute.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'ACS::RAM::User', + ], + 'ComplianceType' => [ + 'description' => 'The compliance status of the resource. Valid values:'."\n" + ."\n" + .'* NonCompliant: non-compliant.'."\n" + .'* Excluded: ignored.'."\n" + .'* PendingExclusion: to be ignored.'."\n" + .'* PendingInclusion: to be unignored.'."\n", + 'type' => 'string', + 'example' => 'NonCompliant', + ], + ], + ], + ], + 'Date' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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 \\"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"}]', + 'title' => 'ListEvaluationMetricDetails', + ], + 'ListEvaluationResults' => [ + 'summary' => 'Queries the result and status of a governance check.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernanceMBMBHG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member. This parameter takes effect only when a multi-account governance maturity check is performed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '176618589410****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The filter conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The filter conditions.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the filter condition. Valid values:'."\n" + ."\n" + .'* ResourceId: the resource ID.'."\n" + .'* ResourceName: the name of the resource.'."\n" + .'* ResourceType: the resource type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceId', + ], + 'Values' => [ + 'description' => 'The list of filter condition values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the filter condition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c191**************b4f', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'es-bp1r**************', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceDirectory', + ], + ], + [ + 'name' => 'LensCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'basic', + ], + ], + [ + 'name' => 'TopicCode', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '治理专题code', + 'type' => 'string', + 'example' => 'IdentityAndAccessManagement', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseBaseResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '176618589410****', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BD57329E-131A-59F4-8746-E1CD8D7B****', + ], + 'Results' => [ + 'description' => 'The check results, including the status of the overall check and the results of check items.'."\n", + 'type' => 'object', + 'properties' => [ + 'EvaluationTime' => [ + 'description' => 'The end time of the overall check. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-12-13T03:35:00Z'."\n", + ], + 'MetricResults' => [ + 'description' => 'The check result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The check result.'."\n", + 'type' => 'object', + 'properties' => [ + 'ErrorInfo' => [ + 'description' => 'The error information.'."\n" + ."\n" + .'> This parameter is returned only if the value of `Status` is `Failed`.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'EcsInsightEnableFailed', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Unable to enable ECS Insight due to a server error.', + ], + ], + ], + 'EvaluationTime' => [ + 'description' => 'The end time of the check item. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-12-13T03:34:02Z', + ], + 'Id' => [ + 'description' => 'The ID of the check item.'."\n", + 'type' => 'string', + 'example' => 'r7xdcu****', + ], + 'ResourcesSummary' => [ + 'description' => 'The checked resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'NonCompliant' => [ + 'description' => 'The number of non-compliant resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'Result' => [ + 'description' => 'The rate of the non-compliant resources.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.67', + ], + 'Risk' => [ + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* Error: high risk'."\n" + .'* Warning: medium risk'."\n" + .'* None: no risk'."\n", + 'type' => 'string', + 'example' => 'Error', + ], + 'Status' => [ + 'description' => 'The status of the check item. Valid values:'."\n" + ."\n" + .'* Running: The check is in progress.'."\n" + .'* Finished: The check is complete.'."\n" + .'* failed: The check fails.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'AccountSummary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NonCompliant' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'PotentialScoreIncrease' => [ + 'title' => '潜在分数提升', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.2', + ], + 'AvailableRemediation' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RemediationTemplateId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => 'The status of the overall check. Valid values:'."\n" + ."\n" + .'* Running: The check is in progress.'."\n" + .'* Finished: The check is complete.'."\n" + .'* failed: The check fails.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'TotalScore' => [ + 'description' => 'The overall score.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6453', + ], + ], + ], + ], + ], + ], + ], + '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 \\"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' => 'ListEvaluationResults', + ], + 'GenerateEvaluationReport' => [ + 'summary' => '生成治理检测报告', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREgovernance9GNJ07', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'RegionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '103144549568****', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EvaluationAccountExcelReport', + 'enum' => [ + 'EvaluationAccountReport', + 'EvaluationAccountExcelReport', + 'EvaluationMultiAccountExcelReport', + 'EvaluationAccountHtmlReport', + ], + ], + ], + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1319994761488600', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'ReportType' => [ + 'description' => '', + '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', + ], + '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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'governance.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'governance.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'governance.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'governance.cn-shanghai-finance-1.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3