diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/resourcemanager | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/resourcemanager')
| -rw-r--r-- | data/en_us/resourcemanager/2016-11-11/api-docs.php | 4654 | ||||
| -rw-r--r-- | data/en_us/resourcemanager/2020-03-31/api-docs.php | 15967 |
2 files changed, 20621 insertions, 0 deletions
diff --git a/data/en_us/resourcemanager/2016-11-11/api-docs.php b/data/en_us/resourcemanager/2016-11-11/api-docs.php new file mode 100644 index 0000000..fd126b0 --- /dev/null +++ b/data/en_us/resourcemanager/2016-11-11/api-docs.php @@ -0,0 +1,4654 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ResourceManager', + 'version' => '2016-11-11', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'AttachPolicy', + 'CancelCreateCloudAccount', + 'CancelPromoteResourceAccount', + 'CreateFolder', + 'CreateCloudAccount', + 'CreatePolicy', + 'CreatePolicyVersion', + 'CreateResourceAccount', + 'CreateResourceGroup', + 'CreateRole', + 'CreateServiceLinkedRole', + 'DeleteFolder', + 'DeleteInvalidCloudAccountRecord', + 'DeletePolicy', + 'DeletePolicyVersion', + 'DeleteResourceGroup', + 'DeleteRole', + 'DeleteServiceLinkedRole', + 'DestroyResourceDirectory', + 'DetachPolicy', + 'GetAccountSummary', + 'GetFolder', + 'GetPolicy', + 'GetPolicyVersion', + 'GetResourceDirectory', + 'GetResourceDirectoryAccount', + 'GetResourceGroup', + 'GetRole', + 'GetServiceLinkedRoleDeletionStatus', + 'GetServiceLinkedRoleTemplate', + 'InitResourceDirectory', + 'ListAccountRecordsForParent', + 'ListAccounts', + 'ListAccountsForParent', + 'ListAncestors', + 'ListFoldersForParent', + 'ListParents', + 'ListPolicies', + 'ListPolicyAttachments', + 'ListPolicyVersions', + 'ListResourceGroups', + 'ListRoles', + 'ListRolesForService', + 'ListTrustedServiceStatus', + 'MoveAccount', + 'PromoteResourceAccount', + 'QueryResource', + 'RemoveCloudAccount', + 'ResendCreateCloudAccountEmail', + 'ResendPromoteResourceAccountEmail', + 'SetDefaultPolicyVersion', + 'UpdateFolder', + 'UpdateResourceGroup', + 'UpdateRole', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AttachPolicy' => [ + 'summary' => '为RAM身份授权', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CancelCreateCloudAccount' => [ + 'summary' => '取消创建云账号类型的成员', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CancelPromoteResourceAccount' => [ + 'summary' => '取消升级资源账号为云账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateFolder' => [ + 'summary' => '创建资源夹', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Folder' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'ParentFolderId' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Folder.Name.AlreadyUsed', + 'errorMessage' => 'The name already exists under the same parent. Please change to another name.', + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateCloudAccount' => [ + 'summary' => '创建云账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'EnableConsolidatedBilling', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'PayerAccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'JoinMethod' => [ + 'type' => 'string', + ], + 'JoinTime' => [ + 'type' => 'string', + ], + 'ModifyTime' => [ + 'type' => 'string', + ], + 'RecordId' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'PaymentAccountEnterpriseVerifyError', + 'errorMessage' => 'The type of the payment account is not enterprise verified.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipVerifyError', + 'errorMessage' => 'The payment account must not be the beneficiary account from other financial relationships.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseTypeError', + 'errorMessage' => 'The type of the payment account is not enterprise.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipsChangeFrequencyVerifyError', + 'errorMessage' => 'The financial relationship of payment account changes too frequently. Please try again later.', + ], + [ + 'errorCode' => 'MemberAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the member account must not be virtual operator.', + ], + [ + 'errorCode' => 'MemberAccountResellerVerifyError', + 'errorMessage' => 'The type of the member account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the payment account must not be virtual operator.', + ], + [ + 'errorCode' => 'PaymentAccountResellerVerifyError', + 'errorMessage' => 'The type of the payment account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountCreditIdentityTypeError', + 'errorMessage' => 'The identity of the payment account is not credit.', + ], + [ + 'errorCode' => 'InconsistentEnterpriseNameError', + 'errorMessage' => 'The enterprise name of the payment account and the member account must be consistent.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseInvoiceError', + 'errorMessage' => 'No enterprise invoice header information is set for the payment account.', + ], + [ + 'errorCode' => 'UnknownFinancialError', + 'errorMessage' => 'An unknown financial error occurred.', + ], + ], + ], + 'responseDemo' => null, + ], + 'CreatePolicy' => [ + 'summary' => '创建权限策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'DefaultVersion' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'PolicyName' => [ + 'type' => 'string', + ], + 'PolicyType' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreatePolicyVersion' => [ + 'summary' => '创建权限策略版本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SetAsDefault', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersion' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'IsDefaultVersion' => [ + 'type' => 'boolean', + ], + 'VersionId' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateResourceAccount' => [ + 'summary' => '创建资源账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EnableConsolidatedBilling', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'PayerAccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'JoinMethod' => [ + 'type' => 'string', + ], + 'JoinTime' => [ + 'type' => 'string', + ], + 'ModifyTime' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'PaymentAccountEnterpriseVerifyError', + 'errorMessage' => 'The type of the payment account is not enterprise verified.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipVerifyError', + 'errorMessage' => 'The payment account must not be the beneficiary account from other financial relationships.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseTypeError', + 'errorMessage' => 'The type of the payment account is not enterprise.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipsChangeFrequencyVerifyError', + 'errorMessage' => 'The financial relationship of payment account changes too frequently. Please try again later.', + ], + [ + 'errorCode' => 'MemberAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the member account must not be virtual operator.', + ], + [ + 'errorCode' => 'MemberAccountResellerVerifyError', + 'errorMessage' => 'The type of the member account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the payment account must not be virtual operator.', + ], + [ + 'errorCode' => 'PaymentAccountResellerVerifyError', + 'errorMessage' => 'The type of the payment account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountCreditIdentityTypeError', + 'errorMessage' => 'The identity of the payment account is not credit.', + ], + [ + 'errorCode' => 'InconsistentEnterpriseNameError', + 'errorMessage' => 'The enterprise name of the payment account and the member account must be consistent.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseInvoiceError', + 'errorMessage' => 'No enterprise invoice header information is set for the payment account.', + ], + [ + 'errorCode' => 'UnknownFinancialError', + 'errorMessage' => 'An unknown financial error occurred.', + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateResourceGroup' => [ + 'summary' => '创建资源组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceGroup' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateRole' => [ + 'summary' => '创建角色', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AssumeRolePolicyDocument', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MaxSessionDuration', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Role' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'type' => 'string', + ], + 'AssumeRolePolicyDocument' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'MaxSessionDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RoleId' => [ + 'type' => 'string', + ], + 'RoleName' => [ + 'type' => 'string', + ], + 'RolePrincipalName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateServiceLinkedRole' => [ + 'summary' => '创建服务关联角色', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CustomSuffix', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Role' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'type' => 'string', + ], + 'AssumeRolePolicyDocument' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'IsServiceLinkedRole' => [ + 'type' => 'boolean', + ], + 'RoleId' => [ + 'type' => 'string', + ], + 'RoleName' => [ + 'type' => 'string', + ], + 'RolePrincipalName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteFolder' => [ + 'summary' => '删除资源夹', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteInvalidCloudAccountRecord' => [ + 'summary' => '删除账号记录', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeletePolicy' => [ + 'summary' => '删除指定权限策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeletePolicyVersion' => [ + 'summary' => '删除权限策略版本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteResourceGroup' => [ + 'summary' => '删除资源组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceGroup' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteRole' => [ + 'summary' => '删除角色', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteServiceLinkedRole' => [ + 'summary' => '删除服务关联角色', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeletionTaskId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DestroyResourceDirectory' => [ + 'summary' => '关闭资源目录', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DetachPolicy' => [ + 'summary' => '为RAM身份移除权限', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetAccountSummary' => [ + 'summary' => '查询账号的概览信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SummaryMap' => [ + 'type' => 'object', + 'properties' => [ + 'AttachedPoliciesPerGroupQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AttachedPoliciesPerRoleQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AttachedPoliciesPerUserQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AttachedSystemPoliciesPerGroupQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AttachedSystemPoliciesPerRoleQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AttachedSystemPoliciesPerUserQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Policies' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PoliciesQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PolicySizeQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ResourceGroups' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ResourceGroupsQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Roles' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RolesQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'VersionsPerPolicyQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetFolder' => [ + 'summary' => '获取资源夹', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Folder' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'ParentFolderId' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetPolicy' => [ + 'summary' => '获取指定的权限策略信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'type' => 'object', + 'properties' => [ + 'AttachmentCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DefaultVersion' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'PolicyDocument' => [ + 'type' => 'string', + ], + 'PolicyName' => [ + 'type' => 'string', + ], + 'PolicyType' => [ + 'type' => 'string', + ], + 'UpdateDate' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetPolicyVersion' => [ + 'summary' => '获取指定权限策略的版本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersion' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'IsDefaultVersion' => [ + 'type' => 'boolean', + ], + 'PolicyDocument' => [ + 'type' => 'string', + ], + 'VersionId' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetResourceDirectory' => [ + 'summary' => '获取资源目录信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceDirectory' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'MasterAccountId' => [ + 'type' => 'string', + ], + 'MasterAccountName' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'RootFolderId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetResourceDirectoryAccount' => [ + 'summary' => '获取账号信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'IdentityInformation' => [ + 'type' => 'string', + ], + 'JoinMethod' => [ + 'type' => 'string', + ], + 'JoinTime' => [ + 'type' => 'string', + ], + 'ModifyTime' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetResourceGroup' => [ + 'summary' => '查询资源组信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceGroup' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetRole' => [ + 'summary' => '获取角色信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Role' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'type' => 'string', + ], + 'AssumeRolePolicyDocument' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'IsServiceLinkedRole' => [ + 'type' => 'boolean', + ], + 'LatestDeletionTask' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'DeletionTaskId' => [ + 'type' => 'string', + ], + ], + ], + 'MaxSessionDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RoleId' => [ + 'type' => 'string', + ], + 'RoleName' => [ + 'type' => 'string', + ], + 'RolePrincipalName' => [ + 'type' => 'string', + ], + 'UpdateDate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetServiceLinkedRoleDeletionStatus' => [ + 'summary' => '获取服务关联角色的删除任务状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DeletionTaskId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Reason' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'type' => 'string', + ], + 'RoleUsages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RoleUsage' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'type' => 'string', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetServiceLinkedRoleTemplate' => [ + 'summary' => '获取服务关联角色模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ServiceLinkedRoleTemplate' => [ + 'type' => 'object', + 'properties' => [ + 'MultipleRolesAllowed' => [ + 'type' => 'boolean', + ], + 'RoleDescriptions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RoleDescription' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'type' => 'string', + ], + 'Language' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RoleNamePrefix' => [ + 'type' => 'string', + ], + 'ServiceName' => [ + 'type' => 'string', + ], + 'SystemPolicyName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'InitResourceDirectory' => [ + 'summary' => '开通资源目录', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceDirectory' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'MasterAccountId' => [ + 'type' => 'string', + ], + 'MasterAccountName' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'RootFolderId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListAccountRecordsForParent' => [ + 'summary' => '查询资源夹下的账号记录', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Record' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'JoinMethod' => [ + 'type' => 'string', + ], + 'JoinTime' => [ + 'type' => 'string', + ], + 'ModifyTime' => [ + 'type' => 'string', + ], + 'RecordId' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListAccounts' => [ + 'summary' => '查询账号列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'JoinMethod' => [ + 'type' => 'string', + ], + 'JoinTime' => [ + 'type' => 'string', + ], + 'ModifyTime' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListAccountsForParent' => [ + 'summary' => '查询节点下的账号列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'JoinMethod' => [ + 'type' => 'string', + ], + 'JoinTime' => [ + 'type' => 'string', + ], + 'ModifyTime' => [ + 'type' => 'string', + ], + 'ResourceDirectoryId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListAncestors' => [ + 'summary' => '查看指定资源夹的所有父资源夹信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ChildId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListFoldersForParent' => [ + 'summary' => '查询节点下的资源夹信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListParents' => [ + 'summary' => '列出所有的父级资源夹', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ChildId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'FolderId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListPolicies' => [ + 'summary' => '查看权限策略列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Policies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Policy' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AttachmentCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DefaultVersion' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'PolicyName' => [ + 'type' => 'string', + ], + 'PolicyType' => [ + 'type' => 'string', + ], + 'UpdateDate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListPolicyAttachments' => [ + 'summary' => '查看授权列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PolicyAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolicyAttachment' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AttachDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'PolicyName' => [ + 'type' => 'string', + ], + 'PolicyType' => [ + 'type' => 'string', + ], + 'PrincipalName' => [ + 'type' => 'string', + ], + 'PrincipalType' => [ + 'type' => 'string', + ], + 'ResourceGroupId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListPolicyVersions' => [ + 'summary' => '查看权限策略版本列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolicyVersion' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'IsDefaultVersion' => [ + 'type' => 'boolean', + ], + 'VersionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListResourceGroups' => [ + 'summary' => '查询资源组列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourceGroup' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListRoles' => [ + 'summary' => '查看角色列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'IsServiceLinkedRole' => [ + 'type' => 'boolean', + ], + 'LatestDeletionTask' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'DeletionTaskId' => [ + 'type' => 'string', + ], + ], + ], + 'MaxSessionDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RoleId' => [ + 'type' => 'string', + ], + 'RoleName' => [ + 'type' => 'string', + ], + 'RolePrincipalName' => [ + 'type' => 'string', + ], + 'UpdateDate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListRolesForService' => [ + 'summary' => '为服务获取角色列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'IsServiceLinkedRole' => [ + 'type' => 'boolean', + ], + 'LatestDeletionTask' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'DeletionTaskId' => [ + 'type' => 'string', + ], + ], + ], + 'MaxSessionDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RoleId' => [ + 'type' => 'string', + ], + 'RoleName' => [ + 'type' => 'string', + ], + 'RolePrincipalName' => [ + 'type' => 'string', + ], + 'UpdateDate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ListTrustedServiceStatus' => [ + 'summary' => '查询企业管理账号或委派管理员账号已启用的可信服务列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnabledServicePrincipals' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EnabledServicePrincipal' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EnableTime' => [ + 'type' => 'string', + ], + 'ServicePrincipal' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDir', + 'errorMessage' => 'The account has not initialized resource directory.', + ], + ], + ], + 'responseDemo' => null, + ], + 'MoveAccount' => [ + 'summary' => '移动成员', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DestinationFolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'PromoteResourceAccount' => [ + 'summary' => '将资源账号升级为云账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RecordId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'QueryResource' => [ + 'summary' => '查询当前账号可以访问的资源组中的资源列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'ResourceGroupId' => [ + 'type' => 'string', + ], + 'ResourceId' => [ + 'type' => 'string', + ], + 'ResourceType' => [ + 'type' => 'string', + ], + 'Service' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveCloudAccount' => [ + 'summary' => '移除云账号类型的成员', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => null, + ], + 'ResendCreateCloudAccountEmail' => [ + 'summary' => '重新发送创建云账号的邮件', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RecordId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ResendPromoteResourceAccountEmail' => [ + 'summary' => '重新发送资源账号升级云账号邮件', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RecordId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetDefaultPolicyVersion' => [ + 'summary' => '设置权限策略默认版本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'UpdateFolder' => [ + 'summary' => '修改资源夹', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Folder.Name.AlreadyUsed', + 'errorMessage' => 'The name already exists under the same parent. Please change to another name.', + ], + ], + ], + 'responseDemo' => null, + ], + 'UpdateResourceGroup' => [ + 'summary' => '更新资源组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'NewDisplayName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ResourceGroup' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'UpdateRole' => [ + 'summary' => '更新角色信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NewAssumeRolePolicyDocument', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NewMaxSessionDuration', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'NewDescription', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Role' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'type' => 'string', + ], + 'AssumeRolePolicyDocument' => [ + 'type' => 'string', + ], + 'CreateDate' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'MaxSessionDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RoleId' => [ + 'type' => 'string', + ], + 'RoleName' => [ + 'type' => 'string', + ], + 'RolePrincipalName' => [ + 'type' => 'string', + ], + 'UpdateDate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/resourcemanager/2020-03-31/api-docs.php b/data/en_us/resourcemanager/2020-03-31/api-docs.php new file mode 100644 index 0000000..cdd4828 --- /dev/null +++ b/data/en_us/resourcemanager/2020-03-31/api-docs.php @@ -0,0 +1,15967 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ResourceManager', + 'version' => '2020-03-31', + ], + 'directories' => [ + [ + 'id' => 142920, + 'title' => 'Resource directory', + 'type' => 'directory', + 'children' => [ + 'EnableResourceDirectory', + 'SendVerificationCodeForEnableRD', + 'GetResourceDirectory', + 'DestroyResourceDirectory', + ], + ], + [ + 'id' => 190386, + 'title' => 'Folders', + 'type' => 'directory', + 'children' => [ + 'CreateFolder', + 'GetFolder', + 'UpdateFolder', + 'DeleteFolder', + 'ListFoldersForParent', + 'ListAncestors', + ], + ], + [ + 'id' => 190387, + 'title' => 'Members', + 'type' => 'directory', + 'children' => [ + 'CreateResourceAccount', + 'UpdateAccount', + 'GetAccount', + 'GetPayerForAccount', + 'ListAccounts', + 'ListAccountsForParent', + 'MoveAccount', + 'RemoveCloudAccount', + 'BindSecureMobilePhone', + 'SendVerificationCodeForBindSecureMobilePhone', + 'ChangeAccountEmail', + 'RetryChangeAccountEmail', + 'CancelChangeAccountEmail', + 'CheckAccountDelete', + 'DeleteAccount', + 'SetMemberDeletionPermission', + 'GetAccountDeletionStatus', + 'GetAccountDeletionCheckResult', + 'InviteAccountToResourceDirectory', + 'GetHandshake', + 'CancelHandshake', + 'ListHandshakesForAccount', + 'ListHandshakesForResourceDirectory', + 'AcceptHandshake', + 'DeclineHandshake', + ], + ], + [ + 'id' => 142993, + 'title' => 'Access control policies', + 'type' => 'directory', + 'children' => [ + 'EnableControlPolicy', + 'GetControlPolicyEnablementStatus', + 'DisableControlPolicy', + 'CreateControlPolicy', + 'GetControlPolicy', + 'UpdateControlPolicy', + 'DeleteControlPolicy', + 'AttachControlPolicy', + 'DetachControlPolicy', + 'ListControlPolicies', + 'ListControlPolicyAttachmentsForTarget', + 'ListTargetAttachmentsForControlPolicy', + ], + ], + [ + 'id' => 190388, + 'title' => 'Trusted services', + 'type' => 'directory', + 'children' => [ + 'ListTrustedServiceStatus', + 'RegisterDelegatedAdministrator', + 'DeregisterDelegatedAdministrator', + 'ListDelegatedAdministrators', + 'ListDelegatedServicesForAccount', + ], + ], + [ + 'id' => 142982, + 'title' => 'Resource groups', + 'type' => 'directory', + 'children' => [ + 'CreateResourceGroup', + 'DeleteResourceGroup', + 'UpdateResourceGroup', + 'ListResourceGroups', + 'ListResources', + 'GetResourceGroup', + 'MoveResources', + 'EnableAutoGrouping', + 'DisableAutoGrouping', + 'UpdateAutoGroupingConfig', + 'GetAutoGroupingStatus', + 'CreateAutoGroupingRule', + 'DeleteAutoGroupingRule', + 'UpdateAutoGroupingRule', + 'ListAutoGroupingRules', + 'GetAutoGroupingRule', + 'EnableAssociatedTransfer', + 'DisableAssociatedTransfer', + 'UpdateAssociatedTransferSetting', + 'ListAssociatedTransferSetting', + 'GetResourceGroupResourceCounts', + 'ListAutoGroupingRemediations', + 'GetResourceGroupAdminSetting', + 'UpdateResourceGroupAdminSetting', + 'LookupResourceGroupEvents', + 'EnableResourceGroupNotification', + 'DisableResourceGroupNotification', + 'GetResourceGroupNotificationSetting', + 'ListResourceGroupCapability', + 'ListResourceGroupsWithAuthDetails', + ], + ], + [ + 'id' => 142976, + 'title' => 'Roles', + 'type' => 'directory', + 'children' => [ + 'CreateRole', + 'DeleteRole', + 'UpdateRole', + 'GetRole', + 'ListRoles', + ], + ], + [ + 'id' => 142958, + 'title' => 'Service-linked roles', + 'type' => 'directory', + 'children' => [ + 'CreateServiceLinkedRole', + 'DeleteServiceLinkedRole', + 'GetServiceLinkedRoleDeletionStatus', + ], + ], + [ + 'id' => 142962, + 'title' => 'Policies', + 'type' => 'directory', + 'children' => [ + 'CreatePolicy', + 'DeletePolicy', + 'SetDefaultPolicyVersion', + 'AttachPolicy', + 'DetachPolicy', + 'ListPolicies', + 'GetPolicy', + 'ListPolicyAttachments', + 'CreatePolicyVersion', + 'DeletePolicyVersion', + 'ListPolicyVersions', + 'GetPolicyVersion', + ], + ], + [ + 'id' => 190389, + 'title' => 'Tag', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + 'ListTagKeys', + 'ListTagValues', + ], + ], + [ + 'id' => 190390, + 'title' => 'Others (not maintained)', + 'type' => 'directory', + 'children' => [ + 'InitResourceDirectory', + 'CreateCloudAccount', + 'PromoteResourceAccount', + 'ResendPromoteResourceAccountEmail', + 'ResendCreateCloudAccountEmail', + 'CancelCreateCloudAccount', + 'CancelPromoteResourceAccount', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'EnableResourceDirectory' => [ + 'summary' => 'Enables a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'MAName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the newly created account.'."\n" + ."\n" + .'Specify the name in the `<Prefix>@rdadmin.aliyunid.com` format. The prefix can contain letters, digits, and special characters but cannot contain consecutive special characters. The prefix must start with a letter or digit and end with a letter or digit. Valid special characters include underscores (\\_), periods (.), and hyphens (-). The prefix must be 2 to 50 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'MASecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number that is bound to the newly created account.'."\n" + ."\n" + .'If you leave this parameter empty, the mobile phone number that is bound to the current account is used. The mobile phone number you specify must be the same as the mobile phone number that you specify when you call the [SendVerificationCodeForEnableRD](~~364248~~) operation to obtain a verification code.'."\n" + ."\n" + .'Specify the mobile phone number in the `<Country code>-<Mobile phone number>` format.'."\n" + ."\n" + .'> Mobile phone numbers in the `86-<Mobile phone number>` format in the Chinese mainland are not supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xx-13900001234', + ], + ], + [ + 'name' => 'VerificationCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The verification code.'."\n" + ."\n" + .'You can call the [SendVerificationCodeForEnableRD](~~364248~~) operation to obtain the verification code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'EnableMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which you enable a resource directory. Valid values:'."\n" + ."\n" + .'* CurrentAccount: indicates that the current account is used to enable a resource directory.'."\n" + .'* NewManagementAccount: indicates that a newly created account is used to enable a resource directory. If you select this mode, you must configure the `MAName`, `MASecureMobilePhone`, and `VerificationCode` parameters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CurrentAccount', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceDirectory' => [ + 'description' => 'The information of the resource directory.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-54****', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account.'."\n", + 'type' => 'string', + 'example' => '507408460615****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'RootFolderId' => [ + 'description' => 'The ID of the Root folder.'."\n", + 'type' => 'string', + 'example' => 'r-G9****', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource directory was enabled.'."\n", + 'type' => 'string', + 'example' => '2021-12-08T02:15:31.744Z', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EC2FE94D-A4A2-51A1-A493-5C273A36C46A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified account is an Alibaba Cloud account or already exists in another resource directory.', + ], + [ + 'errorCode' => 'Invalid.EnterpriseName', + 'errorMessage' => 'You must specify the enterprise name.', + ], + [ + 'errorCode' => 'EnterpriseRealNameVerificationError', + 'errorMessage' => 'The specified account does not pass enterprise real-name verification. We recommend you first complete enterprise real-name verification for the account.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.', + ], + [ + 'errorCode' => 'InvalidParameter.ManagementAccountName.AlreadyUsed', + 'errorMessage' => 'The ManagementAccountName has been used.', + ], + [ + 'errorCode' => 'Invalid.VerificationCode', + 'errorMessage' => 'The verification code is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ManagementAccountName', + 'errorMessage' => 'The management account name is in the wrong format.', + ], + [ + 'errorCode' => 'InvalidParameter.ManagementAccountSecurityInfo', + 'errorMessage' => 'The parameter management account secure mobile phone is invalid.', + ], + [ + 'errorCode' => 'MissingSecureMobilePhone', + 'errorMessage' => 'Secure mobile phone is missing.', + ], + [ + 'errorCode' => 'MissingSecurityInfo', + 'errorMessage' => 'Security info is missing.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResourceDirectory\\": {\\n \\"ResourceDirectoryId\\": \\"rd-54****\\",\\n \\"MasterAccountId\\": \\"507408460615****\\",\\n \\"MasterAccountName\\": \\"[email protected]\\",\\n \\"RootFolderId\\": \\"r-G9****\\",\\n \\"CreateTime\\": \\"2021-12-08T02:15:31.744Z\\"\\n },\\n \\"RequestId\\": \\"EC2FE94D-A4A2-51A1-A493-5C273A36C46A\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableResourceDirectoryResponse>\\n <RequestId>EC2FE94D-A4A2-51A1-A493-5C273A36C46A</RequestId>\\n <ResourceDirectory>\\n <ResourceDirectoryId>rd-54****</ResourceDirectoryId>\\n <MasterAccountName>[email protected]</MasterAccountName>\\n <RootFolderId>r-G9****</RootFolderId>\\n <CreateTime>2021-12-08T02:15:31.744Z</CreateTime>\\n <MasterAccountId>507408460615****</MasterAccountId>\\n </ResourceDirectory>\\n</EnableResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'EnableResourceDirectory', + 'description' => 'You can use the current account or a newly created account to enable a resource directory. For more information, see [Enable a resource directory](~~111215~~).'."\n" + ."\n" + .'In this example, the current account is used to enable a resource directory.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'SendVerificationCodeForEnableRD' => [ + 'summary' => 'Sends a verification code to the mobile phone number bound to a newly created account when you use the account to enable a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number that is bound to the newly created account. If you leave this parameter empty, the mobile phone number that is bound to the current account is used.'."\n" + ."\n" + .'Specify the mobile phone number in the `<Country code>-<Mobile phone number>` format.'."\n" + ."\n" + .'> Mobile phone numbers in the `86-<Mobile phone number>` format in the Chinese mainland are not supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xx-13900001234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EC2FE94D-A4A2-51A1-A493-5C273A36C46A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified account is an Alibaba Cloud account or already exists in another resource directory.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.', + ], + [ + 'errorCode' => 'SendValidateCodeExceedsLimitForAccount', + 'errorMessage' => 'For the same account, the number of verification codes sent exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter.MobileCountryCode', + 'errorMessage' => 'The current site does not support the country code.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC2FE94D-A4A2-51A1-A493-5C273A36C46A\\"\\n}","errorExample":""},{"type":"xml","example":"<SendVerificationCodeForEnableRDResponse>\\n <RequestId>EC2FE94D-A4A2-51A1-A493-5C273A36C46A</RequestId>\\n</SendVerificationCodeForEnableRDResponse>","errorExample":""}]', + 'title' => 'SendVerificationCodeForEnableRD', + 'description' => 'Each Alibaba Cloud account can be used to send a maximum of 100 verification codes per day.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'GetResourceDirectory' => [ + 'summary' => 'Queries the information of a resource directory. If you use a management account to call this API operation, the system returns the information of the resource directory that is enabled by using the management account. If you use a member to call this operation, the system returns the information of', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CD76D376-2517-4924-92C5-DBC52262F93A', + ], + 'ResourceDirectory' => [ + 'description' => 'The information of the resource directory.'."\n", + 'type' => 'object', + 'properties' => [ + 'ControlPolicyStatus' => [ + 'description' => 'The status of the Control Policy feature. Valid values:'."\n" + ."\n" + .'* Enabled: The feature is enabled.'."\n" + .'* PendingEnable: The feature is being enabled.'."\n" + .'* Disabled: The feature is disabled.'."\n" + .'* PendingDisable: The feature is being disabled.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource directory was enabled.'."\n", + 'type' => 'string', + 'example' => '2019-02-18T15:32:10.473Z', + ], + 'IdentityInformation' => [ + 'description' => 'The real-name verification information.'."\n", + 'type' => 'string', + 'example' => '\\*\\*\\* Co., Ltd.', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account.'."\n", + 'type' => 'string', + 'example' => '172845045600****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account.'."\n", + 'type' => 'string', + 'example' => 'aliyun-admin', + ], + 'MemberDeletionStatus' => [ + 'description' => 'The status of the member deletion feature. Valid values:'."\n" + ."\n" + .'* Enabled: The feature is enabled. You can call the [DeleteAccount](~~311546~~) operation to delete members of the resource account type.'."\n" + .'* Disabled: The feature is disabled. You cannot delete members of the resource account type.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-St****', + ], + 'RootFolderId' => [ + 'description' => 'The ID of the Root folder.'."\n", + 'type' => 'string', + 'example' => 'r-Zo****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ResourceDirectoryNotInUse', + 'errorMessage' => 'The specified account is not an Alibaba Cloud account or a member account of the resource directory.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD76D376-2517-4924-92C5-DBC52262F93A\\",\\n \\"ResourceDirectory\\": {\\n \\"ControlPolicyStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2019-02-18T15:32:10.473Z\\",\\n \\"IdentityInformation\\": \\"***有限公司\\",\\n \\"MasterAccountId\\": \\"172845045600****\\",\\n \\"MasterAccountName\\": \\"aliyun-admin\\",\\n \\"MemberDeletionStatus\\": \\"Enabled\\",\\n \\"ResourceDirectoryId\\": \\"rd-St****\\",\\n \\"RootFolderId\\": \\"r-Zo****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResourceDirectoryResponse>\\n <RequestId>CD76D376-2517-4924-92C5-DBC52262F93A</RequestId>\\n <ResourceDirectory>\\n <RootFolderId>r-Zo****</RootFolderId>\\n <ResourceDirectoryId>rd-St****</ResourceDirectoryId>\\n <CreateTime>2019-02-18T15:32:10.473Z</CreateTime>\\n <MasterAccountId>172845045600****</MasterAccountId>\\n <MasterAccountName>aliyun-admin</MasterAccountName>\\n <ControlPolicyStatus>Enabled</ControlPolicyStatus>\\n <MemberDeletionStatus>Enabled</MemberDeletionStatus>\\n <IdentityInformation>***有限公司</IdentityInformation>\\n </ResourceDirectory>\\n</GetResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'GetResourceDirectory', + 'description' => 'This topic provides an example on how to use a management account to call the API operation to query the information of the resource directory that is enabled by using the management account.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DestroyResourceDirectory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DeleteConflict.ResourceDirectory.Account', + 'errorMessage' => 'Failed to delete the resource directory because one or more member accounts exist. We recommend that you first remove these member accounts.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DestroyResourceDirectoryResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</DestroyResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'DestroyResourceDirectory', + 'summary' => 'Disables a resource directory. This operation cannot be undone. Therefore, exercise caution when you perform it.', + 'description' => 'Before you disable a resource directory, make sure that the following requirements are met:'."\n" + ."\n" + .'* All member accounts must be removed from the resource directory. For more information about how to remove a member account, see [RemoveCloudAccount](~~159431~~).'."\n" + .'* All folders except the root folder must be deleted from the resource directory. For more information about how to delete a folder, see [DeleteFolder](~~159432~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateFolder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'r-b1****', + ], + ], + [ + 'name' => 'FolderName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the folder.'."\n" + ."\n" + .'The name must be 1 to 24 characters in length and can contain letters, digits, underscores (\\_), periods (.),and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rdFolder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + 'Folder' => [ + 'description' => 'The information of the folder.'."\n", + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-u8B321****', + ], + 'CreateTime' => [ + 'description' => 'The time when the folder was created.'."\n", + 'type' => 'string', + 'example' => '2019-02-19T09:34:50.757Z', + ], + 'ParentFolderId' => [ + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'example' => 'r-b1****', + ], + 'FolderName' => [ + 'description' => 'The name of the folder.'."\n", + 'type' => 'string', + 'example' => 'rdFolder', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ParentFolderId', + 'errorMessage' => 'The ParentFolderId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.Folder.Name', + 'errorMessage' => 'You must specify the resource folder name.', + ], + [ + 'errorCode' => 'InvalidParameter.Folder.Name', + 'errorMessage' => 'The Name of folder is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Folder.Name.Length', + 'errorMessage' => 'The Name of folder exceeds the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.Folder.Name.AlreadyUsed', + 'errorMessage' => 'The name already exists under the same parent. Please change to another name.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.Folder.Depth', + 'errorMessage' => 'The folder depth exceeds the limit of 5.', + ], + [ + 'errorCode' => 'QuotaExceeded.Folder.Count', + 'errorMessage' => 'The number of folders exceeds the quota.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2CBCA30-C8DD-423E-B4AD-4FB694C9180C\\",\\n \\"Folder\\": {\\n \\"FolderId\\": \\"fd-u8B321****\\",\\n \\"CreateTime\\": \\"2019-02-19T09:34:50.757Z\\",\\n \\"ParentFolderId\\": \\"r-b1****\\",\\n \\"FolderName\\": \\"rdFolder\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateFolderResponse>\\r\\n <Folder>\\r\\n <FolderName>rdFolder</FolderName> \\r\\n <ParentFolderId>r-b1****</ParentFolderId>\\r\\n <FolderId>fd-u8B321****</FolderId>\\r\\n <CreateTime>2019-02-19T09:34:50.757Z</CreateTime>\\r\\n </Folder>\\r\\n <RequestId>C2CBCA30-C8DD-423E-B4AD-4FB694C9180C</RequestId>\\r\\n</CreateFolderResponse>","errorExample":""}]', + 'title' => 'CreateFolder', + 'summary' => 'Creates a folder.', + 'description' => '> A maximum of five levels of folders can be created under the root folder.'."\n" + ."\n" + .'In this example, a folder named `rdFolder` is created under the root folder.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetFolder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fd-Jyl5U7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + 'Folder' => [ + 'description' => 'The information of the folder.'."\n", + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-Jyl5U7****', + ], + 'CreateTime' => [ + 'description' => 'The time when the folder was created.'."\n", + 'type' => 'string', + 'example' => '2021-06-15T06:39:08.521Z', + ], + 'ParentFolderId' => [ + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'example' => 'r-Wm****', + ], + 'FolderName' => [ + 'description' => 'The name of the folder.'."\n", + 'type' => 'string', + 'example' => 'Applications', + ], + 'ResourceDirectoryPath' => [ + 'description' => 'The path of the folder in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****/r-Wm****/fd-Jyl5U7****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.FolderId', + 'errorMessage' => 'You must specify FolderId.', + ], + [ + 'errorCode' => 'InvalidParameter.FolderId', + 'errorMessage' => 'The FolderId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2CBCA30-C8DD-423E-B4AD-4FB694C9180C\\",\\n \\"Folder\\": {\\n \\"FolderId\\": \\"fd-Jyl5U7****\\",\\n \\"CreateTime\\": \\"2021-06-15T06:39:08.521Z\\",\\n \\"ParentFolderId\\": \\"r-Wm****\\",\\n \\"FolderName\\": \\"Applications\\",\\n \\"ResourceDirectoryPath\\": \\"rd-3G****/r-Wm****/fd-Jyl5U7****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetFolderResponse>\\r\\n\\t<RequestId>88EF473E-D5CD-589F-AAB3-F6E0D12AECA3</RequestId>\\r\\n\\t<Folder>\\r\\n\\t\\t<CreateTime>2021-06-15T06:39:08.521Z</CreateTime>\\r\\n\\t\\t<FolderId>fd-Jyl5U7****</FolderId>\\r\\n\\t\\t<FolderName>Applications</FolderName>\\r\\n\\t\\t<ParentFolderId>r-Wm****</ParentFolderId>\\r\\n\\t\\t<ResourceDirectoryPath>rd-3G****/r-Wm****/fd-Jyl5U7****</ResourceDirectoryPath>\\r\\n\\t</Folder>\\r\\n</GetFolderResponse>","errorExample":""}]', + 'title' => 'GetFolder', + 'summary' => 'Queries the information of a folder.', + 'description' => 'In this example, the information of the folder `fd-Jyl5U7****` is queried.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFolder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fd-u8B321****', + ], + ], + [ + 'name' => 'NewFolderName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the folder.'."\n" + ."\n" + .'The name must be 1 to 24 characters in length and can contain letters, digits, underscores (\\_), periods (.), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rdFolder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + 'Folder' => [ + 'description' => 'The information of the folder.'."\n", + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-u8B321****', + ], + 'CreateTime' => [ + 'description' => 'The time when the folder was created.'."\n", + 'type' => 'string', + 'example' => '2019-02-19T09:34:50.757Z', + ], + 'ParentFolderId' => [ + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'example' => 'r-b1****', + ], + 'FolderName' => [ + 'description' => 'The name of the folder.'."\n", + 'type' => 'string', + 'example' => 'rdFolder', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.Folder.Name', + 'errorMessage' => 'You must specify the resource folder name.', + ], + [ + 'errorCode' => 'InvalidParameter.Folder.Name', + 'errorMessage' => 'The Name of folder is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Folder.Name.Length', + 'errorMessage' => 'The Name of folder exceeds the length limit.', + ], + [ + 'errorCode' => 'MissingParameter.FolderId', + 'errorMessage' => 'You must specify FolderId.', + ], + [ + 'errorCode' => 'InvalidParameter.FolderId', + 'errorMessage' => 'The FolderId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Folder.Name.AlreadyUsed', + 'errorMessage' => 'The name already exists under the same parent. Please change to another name.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.Folder.Depth', + 'errorMessage' => 'The folder depth exceeds the limit of 5.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2CBCA30-C8DD-423E-B4AD-4FB694C9180C\\",\\n \\"Folder\\": {\\n \\"FolderId\\": \\"fd-u8B321****\\",\\n \\"CreateTime\\": \\"2019-02-19T09:34:50.757Z\\",\\n \\"ParentFolderId\\": \\"r-b1****\\",\\n \\"FolderName\\": \\"rdFolder\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateFolderResponse>\\r\\n <Folder>\\r\\n <FolderName>rdFolder</FolderName>\\r\\n <ParentFolderId>r-b1****</ParentFolderId>\\r\\n <FolderId>fd-u8B321****</FolderId>\\r\\n <CreateTime>2019-02-19T09:34:50.757Z</CreateTime>\\r\\n </Folder>\\r\\n <RequestId>C2CBCA30-C8DD-423E-B4AD-4FB694C9180C</RequestId>\\r\\n</UpdateFolderResponse>","errorExample":""}]', + 'title' => 'UpdateFolder', + 'summary' => 'Changes the name of a folder.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFolder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fd-ae1in7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.FolderId', + 'errorMessage' => 'You must specify FolderId.', + ], + [ + 'errorCode' => 'InvalidParameter.FolderId', + 'errorMessage' => 'The FolderId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DeleteConflict.Folder.SubFolder', + 'errorMessage' => 'This folder has sub folders.', + ], + [ + 'errorCode' => 'DeleteConflict.Folder.Account', + 'errorMessage' => 'This folder has accounts.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteFolderResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</DeleteFolderResponse>","errorExample":""}]', + 'title' => 'DeleteFolder', + 'summary' => 'Deletes a folder.', + 'description' => '> Before you delete a folder, make sure that the folder does not contain any member accounts or child folders.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFoldersForParent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent folder.'."\n" + ."\n" + .'If you leave this parameter empty, the information of the first-level subfolders of the Root folder is queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'r-b1****', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword used for the query, such as a folder name.'."\n" + ."\n" + .'Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rdFolder', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'description' => 'The information of the folders.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'rd-evic31****', + ], + 'CreateTime' => [ + 'description' => 'The time when the folder was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'FolderName' => [ + 'description' => 'The name of the folder.'."\n", + 'type' => 'string', + 'example' => 'project-1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ParentFolderId', + 'errorMessage' => 'The ParentFolderId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"PageSize\\": 5,\\n \\"PageNumber\\": 1,\\n \\"Folders\\": {\\n \\"Folder\\": [\\n {\\n \\"FolderId\\": \\"rd-evic31****\\",\\n \\"CreateTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"FolderName\\": \\"project-1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListFoldersForParentResponse>\\r\\n <RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\r\\n <PageNumber>1</PageNumber>\\r\\n <PageSize>5</PageSize>\\r\\n <TotalCount>2</TotalCount>\\r\\n <Folders>\\r\\n <Folder>\\r\\n <FolderId>rd-evic31****</FolderId>\\r\\n <FolderName>project-1</FolderName>\\r\\n <CreateTime>2015-01-23T12:33:18Z</CreateTime>\\r\\n </Folder>\\r\\n <Folder>\\r\\n <FolderId>fd-evic31****</FolderId>\\r\\n <FolderName>project-2</FolderName>\\r\\n <CreateTime>2015-01-23T12:33:18Z</CreateTime>\\r\\n </Folder>\\r\\n </Folders>\\r\\n</ListFoldersForParentResponse>","errorExample":""}]', + 'title' => 'ListFoldersForParent', + 'summary' => 'Queries the information of all subfolders of a folder.', + 'description' => '> You can view the information of only the first-level subfolders of a folder.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAncestors' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ChildId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the child folder.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fd-i1c9nr****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '83AFBEB6-DC03-406E-9686-867461FF6698', + ], + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'description' => 'The information of the folders.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'r-b1****', + ], + 'CreateTime' => [ + 'description' => 'The time when the folder was created.'."\n", + 'type' => 'string', + 'example' => '2019-01-18T10:03:35.217Z', + ], + 'FolderName' => [ + 'description' => 'The name of the folder.'."\n", + 'type' => 'string', + 'example' => 'root', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ChildId', + 'errorMessage' => 'You must specify ChildId.', + ], + [ + 'errorCode' => 'InvalidParameter.ChildId', + 'errorMessage' => 'The ChildId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"83AFBEB6-DC03-406E-9686-867461FF6698\\",\\n \\"Folders\\": {\\n \\"Folder\\": [\\n {\\n \\"FolderId\\": \\"r-b1****\\",\\n \\"CreateTime\\": \\"2019-01-18T10:03:35.217Z\\",\\n \\"FolderName\\": \\"root\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListAncestorsResponse>\\r\\n <Folders>\\r\\n <Folder>\\r\\n <FolderName>root</FolderName>\\r\\n <FolderId>r-b1****</FolderId>\\r\\n <CreateTime>2019-01-18T10:03:35.217Z</CreateTime>\\r\\n </Folder>\\r\\n <Folder>\\r\\n <FolderName>myFirstFd</FolderName>\\r\\n <FolderId>fd-0adR35****</FolderId>\\r\\n <CreateTime>2019-01-23T08:48:37.530Z</CreateTime>\\r\\n </Folder>\\r\\n </Folders>\\r\\n <RequestId>83AFBEB6-DC03-406E-9686-867461FF6698</RequestId>\\r\\n</ListAncestorsResponse>","errorExample":""}]', + 'title' => 'ListAncestors', + 'summary' => 'Queries the information of all the parent folders of a specified folder. The system returns the information of the folders based on their top-down hierarchy.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateResourceAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the member.'."\n" + ."\n" + .'The name must be 2 to 50 characters in length.'."\n" + ."\n" + .'The name can contain letters, digits, underscores (\\_), periods (.), hyphens (-), and spaces.'."\n" + ."\n" + .'The name must be unique in the resource directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dev', + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fd-r23M55****', + ], + ], + [ + 'name' => 'PayerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the billing account. If you leave this parameter empty, the newly created member is used as its billing account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12323344****', + ], + ], + [ + 'name' => 'AccountNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix for the Alibaba Cloud account name of the member. If you leave this parameter empty, the system randomly generates a prefix.'."\n" + ."\n" + .'The prefix must be 2 to 37 characters in length.'."\n" + ."\n" + .'The prefix can contain letters, digits, and special characters but cannot contain consecutive special characters. The prefix must start with a letter or digit and end with a letter or digit. Valid special characters include underscores (`_`), periods (`.`), and hyphens (-).'."\n" + ."\n" + .'The complete Alibaba Cloud account name of a member is in the @.aliyunid.com format, such as `alice@rd-3G****.aliyunid.com`.'."\n" + ."\n" + .'Each name must be unique in the resource directory.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alice', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tag of the member.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key and value.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResellAccountType', + 'in' => 'query', + 'schema' => [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information about the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the member. The value CreateSuccess indicates that the member is created.'."\n", + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => 'The type of the member. The value ResourceAccount indicates that the member is a resource account.'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'Dev', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-r23M55****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'JoinTime' => [ + 'description' => 'The time when the member joined the resource directory. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-12-31T03:37:39.456Z', + ], + 'AccountId' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'string', + 'example' => '112730938585****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member joins the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member is invited to join the resource directory.'."\n" + .'* created: The member is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-12-31T03:37:39.456Z', + ], + 'AccountName' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'example' => 'alice@rd-3g****.aliyunid.com', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B356A415-D860-43E5-865A-E2193D62BBD6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.Account.DisplayName', + 'errorMessage' => 'You must specify DisplayName.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName', + 'errorMessage' => 'The DisplayName of account is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName.Length', + 'errorMessage' => 'The DisplayName of the account exceeds the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ParentFolderId', + 'errorMessage' => 'The ParentFolderId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.AccountNamePrefix', + 'errorMessage' => 'The account name prefix is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.AccountNamePrefix.Length', + 'errorMessage' => 'The account name prefix exceeds the length limit.', + ], + [ + 'errorCode' => 'NotSupport.Site.Action', + 'errorMessage' => 'Site does not allow current action.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.Account', + 'errorMessage' => 'The maximum number of member accounts in a resource directory exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName.AlreadyUsed', + 'errorMessage' => 'The displayname of account has been used.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory.Account', + 'errorMessage' => 'The email address that the system generates when you create a member account already exists. Try again later.', + ], + [ + 'errorCode' => 'Invalid.PayRelation', + 'errorMessage' => 'Failed to create a member. The specified billing account is unavailable. Please change to another billing account and try again.', + ], + [ + 'errorCode' => 'NotSupport.PayerAccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified settlement account does not exist in the resource directory. You must specify a valid settlement account.', + ], + [ + 'errorCode' => 'CreateAccountDisabled', + 'errorMessage' => 'The specified resource directory cannot create a new account.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseVerifyError', + 'errorMessage' => 'The type of the payment account is not enterprise verified.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipVerifyError', + 'errorMessage' => 'The payment account must not be the beneficiary account from other financial relationships.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseTypeError', + 'errorMessage' => 'The type of the payment account is not enterprise.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipsChangeFrequencyVerifyError', + 'errorMessage' => 'The financial relationship of payment account changes too frequently. Please try again later.', + ], + [ + 'errorCode' => 'MemberAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the member account must not be virtual operator.', + ], + [ + 'errorCode' => 'MemberAccountResellerVerifyError', + 'errorMessage' => 'The type of the member account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the payment account must not be virtual operator.', + ], + [ + 'errorCode' => 'PaymentAccountResellerVerifyError', + 'errorMessage' => 'The type of the payment account must not be reseller.', + ], + [ + 'errorCode' => 'InconsistentEnterpriseNameError', + 'errorMessage' => 'The enterprise name of the payment account and the member account must be consistent.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseInvoiceError', + 'errorMessage' => 'No enterprise invoice header information is set for the payment account.', + ], + [ + 'errorCode' => 'UnknownFinancialError', + 'errorMessage' => 'An unknown financial error occurred.', + ], + [ + 'errorCode' => 'BusinessRestricted', + 'errorMessage' => 'Business is restricted. Please contact your customer service manager.', + ], + [ + 'errorCode' => 'PaymentAccountCreditIdentityTypeError', + 'errorMessage' => 'Non-credit identity type or insufficient credit limit, cannot be used as payment account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"Status\\": \\"CreateSuccess\\",\\n \\"Type\\": \\"ResourceAccount\\",\\n \\"DisplayName\\": \\"Dev\\",\\n \\"FolderId\\": \\"fd-r23M55****\\",\\n \\"ResourceDirectoryId\\": \\"rd-3G****\\",\\n \\"JoinTime\\": \\"2020-12-31T03:37:39.456Z\\",\\n \\"AccountId\\": \\"112730938585****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ModifyTime\\": \\"2020-12-31T03:37:39.456Z\\",\\n \\"AccountName\\": \\"alice@rd-3g****.aliyunid.com\\"\\n },\\n \\"RequestId\\": \\"B356A415-D860-43E5-865A-E2193D62BBD6\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateResourceAccountResponse>\\n <Account>\\n <Status>CreateSuccess</Status>\\n <Type>ResourceAccount</Type>\\n <DisplayName>Dev</DisplayName>\\n <FolderId>fd-r23M55****</FolderId>\\n <ResourceDirectoryId>rd-3G****</ResourceDirectoryId>\\n <JoinTime>2020-12-31T03:37:39.456Z</JoinTime>\\n <AccountId>112730938585****</AccountId>\\n <JoinMethod>created</JoinMethod>\\n <ModifyTime>2020-12-31T03:37:39.456Z</ModifyTime>\\n <AccountName>alice@rd-3g****.aliyunid.com</AccountName>\\n </Account>\\n <RequestId>B356A415-D860-43E5-865A-E2193D62BBD6</RequestId>\\n</CreateResourceAccountResponse>","errorExample":""}]', + 'title' => 'CreateResourceAccount', + 'summary' => 'Creates a member of the resource account type.', + 'description' => 'A member serves as a container for resources and is also an organizational unit in a resource directory. A member indicates a project or application. The resources of different members are isolated.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'NewDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new display name of the member.'."\n" + ."\n" + .'> You can configure either the `NewDisplayName` or `NewAccountType` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'NewAccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new type of the member. Valid values:'."\n" + ."\n" + .'* ResourceAccount: resource account'."\n" + .'* CloudAccount: cloud account'."\n" + ."\n" + .'> You can configure either the `NewDisplayName` or `NewAccountType` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceAccount', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that corresponds to the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '12323344****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the member. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member is created.'."\n" + .'* InviteSuccess: The member accepts the invitation.'."\n" + .'* Removed: The member is removed.'."\n" + .'* SwitchSuccess: The type of the member is switched.'."\n", + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => 'The type of the member. Valid values:'."\n" + ."\n" + .'* CloudAccount: cloud account'."\n" + .'* ResourceAccount: resource account'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'JoinTime' => [ + 'description' => 'The time when the member joined the resource directory. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account that corresponds to the member.'."\n", + 'type' => 'string', + 'example' => '12323344****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member joins the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member is invited to join the resource directory.'."\n" + .'* created: The member is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountName' => [ + 'description' => 'The name of the Alibaba Cloud account that corresponds to the member.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName.AlreadyUsed', + 'errorMessage' => 'The displayname of account has been used.', + ], + [ + 'errorCode' => 'MissingDisplayNameOrAccountType', + 'errorMessage' => 'Either display name or account type must be specified.', + ], + [ + 'errorCode' => 'AccountTypeMismatch', + 'errorMessage' => 'The type or status of the member account cannot satisfy the current operation.', + ], + [ + 'errorCode' => 'LegalEntityDifferent', + 'errorMessage' => 'The account legal entity is different from the one of the Management Account.', + ], + [ + 'errorCode' => 'CallerIdentityError', + 'errorMessage' => 'Please use the RAM user or role of the Management Account.', + ], + [ + 'errorCode' => 'MissingSecurityInfo', + 'errorMessage' => 'The current member is not configured with a secure email or mobile phone, and the switchover fails.', + ], + [ + 'errorCode' => 'PrimaryAkInUse', + 'errorMessage' => 'The root user has an AccessKey pair in use.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"Status\\": \\"CreateSuccess\\",\\n \\"Type\\": \\"ResourceAccount\\",\\n \\"DisplayName\\": \\"admin\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"ResourceDirectoryId\\": \\"rd-k3****\\",\\n \\"JoinTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AccountId\\": \\"12323344****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AccountName\\": \\"[email protected]\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n <Account>\\r\\n <ResourceDirectoryId>rd-k3****</ResourceDirectoryId>\\r\\n <AccountId>12323344****</AccountId>\\r\\n <DisplayName>admin</DisplayName>\\r\\n <FolderId>fd-bVaRIG****</FolderId>\\r\\n <JoinMethod>created</JoinMethod>\\r\\n <JoinTime>2015-01-23T12:33:18Z</JoinTime>\\r\\n <Type>ResourceAccount</Type>\\r\\n <Status>CreateSuccess</Status>\\r\\n <RecordId>06950264-3f0d-4ca9-82dd-6ee7a3d33d6b</RecordId>\\r\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\r\\n </Account>\\r\\n</UpdateAccountResponse>","errorExample":""}]', + 'title' => 'UpdateAccount', + 'summary' => 'Changes the display name of a member, or switches the type of a member.', + 'description' => '* To ensure that the system can record the operators of management operations, you must use a RAM user or RAM role to which the AliyunResourceDirectoryFullAccess policy is attached within the management account of your resource directory to call this operation.'."\n" + .'* Before you switch the type of a member from resource account to cloud account, make sure that specific conditions are met. For more information about the conditions, see [Switch a resource account to a cloud account](~~111233~~).'."\n" + .'* Before you switch the type of a member from cloud account to resource account, make sure that specific conditions are met. For more information about the conditions, see [Switch a cloud account to a resource account](~~209980~~).'."\n" + ."\n" + .'This example provides an example on how to call the API operation to change the display name of the member `12323344****` to `admin`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags. Valid values:'."\n" + ."\n" + .'* false (default value)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the member. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member is created.'."\n" + .'* PromoteVerifying: The upgrade of the member is being confirmed.'."\n" + .'* PromoteFailed: The upgrade of the member fails.'."\n" + .'* PromoteExpired: The upgrade of the member expires.'."\n" + .'* PromoteCancelled: The upgrade of the member is canceled.'."\n" + .'* PromoteSuccess: The member is upgraded.'."\n" + .'* InviteSuccess: The member accepts the invitation.'."\n", + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => 'The type of the member. Valid values:'."\n" + ."\n" + .'* CloudAccount: cloud account'."\n" + .'* ResourceAccount: resource account'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'IdentityInformation' => [ + 'description' => 'The real-name verification information.'."\n", + 'type' => 'string', + 'example' => 'aliyun-admin', + ], + 'JoinTime' => [ + 'description' => 'The time when the member joined the resource directory.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'example' => '181761095690****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member joins the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member is invited to join the resource directory.'."\n" + .'* created: The member is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member was modified.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountName' => [ + 'description' => 'The Alibaba Cloud account name of the member.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ResourceDirectoryPath' => [ + 'description' => 'The path of the member in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****/r-Wm****/fd-bVaRIG****/181761095690****', + ], + 'Tags' => [ + 'description' => 'The tags that are added to the member.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'example' => 'tag_value', + ], + ], + ], + ], + 'Location' => [ + 'description' => 'The location of the member in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'root/AlRd****/Z5Aa****', + ], + 'EmailStatus' => [ + 'description' => 'The status of the modification for the email address bound to the member. Valid values:'."\n" + ."\n" + .'* WAIT_MODIFY: in progress'."\n" + .'* CANCELLED: canceled'."\n" + .'* EXPIRED: expired'."\n" + ."\n" + .'If the value of this parameter is empty, no modification is performed for the email address.'."\n", + 'type' => 'string', + 'example' => 'WAIT_MODIFY', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"Status\\": \\"CreateSuccess\\",\\n \\"Type\\": \\"ResourceAccount\\",\\n \\"DisplayName\\": \\"admin\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"ResourceDirectoryId\\": \\"rd-k3****\\",\\n \\"IdentityInformation\\": \\"aliyun-admin\\",\\n \\"JoinTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AccountId\\": \\"181761095690****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"ResourceDirectoryPath\\": \\"rd-k3****/r-Wm****/fd-bVaRIG****/181761095690****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Location\\": \\"root/AlRd****/Z5Aa****\\",\\n \\"EmailStatus\\": \\"WAIT_MODIFY\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAccountResponse>\\n <Account>\\n <Status>CreateSuccess</Status>\\n <Type>ResourceAccount</Type>\\n <DisplayName>admin</DisplayName>\\n <FolderId>fd-bVaRIG****</FolderId>\\n <ResourceDirectoryId>rd-k3****</ResourceDirectoryId>\\n <IdentityInformation>aliyun-admin</IdentityInformation>\\n <JoinTime>2015-01-23T12:33:18Z</JoinTime>\\n <AccountId>181761095690****</AccountId>\\n <JoinMethod>created</JoinMethod>\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\n <AccountName>[email protected]</AccountName>\\n <ResourceDirectoryPath>rd-k3****/r-Wm****/fd-bVaRIG****/181761095690****</ResourceDirectoryPath>\\n <Tags>\\n <Key>tag_key</Key>\\n <Value>tag_value</Value>\\n </Tags>\\n <Location>root/AlRd****/Z5Aa****</Location>\\n <EmailStatus>WAIT_MODIFY</EmailStatus>\\n </Account>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n</GetAccountResponse>","errorExample":""}]', + 'title' => 'GetAccount', + 'summary' => 'Queries the information of a member.', + 'description' => 'This topic provides an example on how to call the API operation to query the information of the member whose Alibaba Cloud account ID is `181761095690****`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPayerForAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12323344****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PayerAccountName' => [ + 'description' => 'The name of the settlement account.'."\n", + 'type' => 'string', + 'example' => 'Alice', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'PayerAccountId' => [ + 'description' => 'The ID of the settlement account.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PayerAccountName\\": \\"Alice\\",\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"PayerAccountId\\": \\"172841235500****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetPayerForAccountResponse>\\r\\n\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n\\t<PayerAccountId>172841235500****</PayerAccountId>\\r\\n\\t<PayerAccountName>Alice</PayerAccountName>\\r\\n</GetPayerForAccountResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'GetPayerForAccount', + 'summary' => 'Queries the information of a settlement account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAccounts' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tag key and value.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key and value.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag_value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags. Valid values:'."\n" + ."\n" + .'* false (default value)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => 'The members returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The members returned.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the member. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member is created.'."\n" + .'* PromoteVerifying: The upgrade of the member is being confirmed.'."\n" + .'* PromoteFailed: The upgrade of the member fails.'."\n" + .'* PromoteExpired: The upgrade of the member expires.'."\n" + .'* PromoteCancelled: The upgrade of the member is canceled.'."\n" + .'* PromoteSuccess: The member is upgraded.'."\n" + .'* InviteSuccess: The member accepts the invitation.'."\n", + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => 'The type of the member. Valid values:'."\n" + ."\n" + .'* CloudAccount: cloud account'."\n" + .'* ResourceAccount: resource account'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-QRzuim****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'JoinTime' => [ + 'description' => 'The time when the member joined the resource directory. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-18T08:01:50.522Z', + ], + 'AccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'example' => '181761095690****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member joins the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member is invited to join the resource directory.'."\n" + .'* created: The member is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-18T08:04:37.668Z', + ], + 'ResourceDirectoryPath' => [ + 'description' => 'The path of the member in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****/r-Wm****/fd-QRzuim****/181761095690****', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are added to the member.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are added to the member.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'example' => 'tag_value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"PageSize\\": 5,\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"Status\\": \\"CreateSuccess\\",\\n \\"Type\\": \\"ResourceAccount\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"FolderId\\": \\"fd-QRzuim****\\",\\n \\"ResourceDirectoryId\\": \\"rd-3G****\\",\\n \\"JoinTime\\": \\"2021-01-18T08:01:50.522Z\\",\\n \\"AccountId\\": \\"181761095690****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ModifyTime\\": \\"2021-01-18T08:04:37.668Z\\",\\n \\"ResourceDirectoryPath\\": \\"rd-3G****/r-Wm****/fd-QRzuim****/181761095690****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAccountsResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>2</PageNumber>\\n <Accounts>\\n <Status>CreateSuccess</Status>\\n <Type>ResourceAccount</Type>\\n <DisplayName>test</DisplayName>\\n <FolderId>fd-QRzuim****</FolderId>\\n <ResourceDirectoryId>rd-3G****</ResourceDirectoryId>\\n <JoinTime>2021-01-18T08:01:50.522Z</JoinTime>\\n <AccountId>181761095690****</AccountId>\\n <JoinMethod>created</JoinMethod>\\n <ModifyTime>2021-01-18T08:04:37.668Z</ModifyTime>\\n <ResourceDirectoryPath>rd-3G****/r-Wm****/fd-QRzuim****/181761095690****</ResourceDirectoryPath>\\n <Tags>\\n <Key>tag_key</Key>\\n <Value>tag_value</Value>\\n </Tags>\\n </Accounts>\\n</ListAccountsResponse>","errorExample":""}]', + 'title' => 'ListAccounts', + 'summary' => 'Queries all the members in a resource directory.', + 'description' => 'You can use only the management account of a resource directory or a delegated administrator account of a trusted service to call this operation.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAccountsForParent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fd-bVaRIG****', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword used for the query, such as the display name of a member.'."\n" + ."\n" + .'Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tag key and value.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key and value.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag_value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags. Valid values:'."\n" + ."\n" + .'false (default value)'."\n" + ."\n" + .'true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the members.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the member. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member is created.'."\n" + .'* PromoteVerifying: The upgrade of the member is being confirmed.'."\n" + .'* PromoteFailed: The upgrade of the member fails.'."\n" + .'* PromoteExpired: The upgrade of the member expires.'."\n" + .'* PromoteCancelled: The upgrade of the member is canceled.'."\n" + .'* PromoteSuccess: The member is upgraded.'."\n" + .'* InviteSuccess: The member accepts the invitation.'."\n", + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => 'The type of the member.'."\n" + ."\n" + .'* CloudAccount: cloud account'."\n" + .'* ResourceAccount: resource account'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k4****', + ], + 'JoinTime' => [ + 'description' => 'The time when the member joined the resource directory. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'example' => '184311716100****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member joins the resource directory.'."\n" + ."\n" + .'* invited: The member is invited to join the resource directory.'."\n" + .'* created: The member is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are added to the member.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are added to the member.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'example' => 'tag_value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ParentFolderId', + 'errorMessage' => 'The ParentFolderId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"PageSize\\": 5,\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"Status\\": \\"CreateSuccess\\",\\n \\"Type\\": \\"ResourceAccount\\",\\n \\"DisplayName\\": \\"admin\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"ResourceDirectoryId\\": \\"rd-k4****\\",\\n \\"JoinTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AccountId\\": \\"184311716100****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAccountsForParentResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>2</PageNumber>\\n <Accounts>\\n <Status>CreateSuccess</Status>\\n <Type>ResourceAccount</Type>\\n <DisplayName>admin</DisplayName>\\n <FolderId>fd-bVaRIG****</FolderId>\\n <ResourceDirectoryId>rd-k4****</ResourceDirectoryId>\\n <JoinTime>2015-01-23T12:33:18Z</JoinTime>\\n <AccountId>184311716100****</AccountId>\\n <JoinMethod>created</JoinMethod>\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\n <Tags>\\n <Key>tag_key</Key>\\n <Value>tag_value</Value>\\n </Tags>\\n </Accounts>\\n</ListAccountsForParentResponse>","errorExample":""}]', + 'title' => 'ListAccountsForParent', + 'summary' => 'Queries the information of members in a folder.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MoveAccount' => [ + 'summary' => 'Moves a member account from a folder to another.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account you want to move.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12323344****', + ], + ], + [ + 'name' => 'DestinationFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination folder.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fd-bVaRIG****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.DestinationFolderId', + 'errorMessage' => 'You must specify DestinationFolderId.', + ], + [ + 'errorCode' => 'InvalidParameter.DestinationFolderId', + 'errorMessage' => 'The DestinationFolderId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<MoveAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</MoveAccountResponse>","errorExample":""}]', + 'title' => 'MoveAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveCloudAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '177242285274****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + [ + 'errorCode' => 'Deny.TrustedService', + 'errorMessage' => 'You attempted to remove an account that is used in %s. To complete this operation, you must first remove this account from the Trusted Service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<RemoveCloudAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</RemoveCloudAccountResponse>","errorExample":""}]', + 'title' => 'RemoveCloudAccount', + 'summary' => 'Removes a member of the cloud account type. After you remove a member of the cloud account type, the member is no longer managed by the management account of the resource directory to which the member belonged.', + 'description' => 'This topic provides an example on how to call the API operation to remove the member `177242285274****` from a resource directory.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindSecureMobilePhone' => [ + 'summary' => 'Binds a mobile phone number to a member of the resource account type in a resource directory for security purposes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'VerificationCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The verification code.'."\n" + ."\n" + .'You can call the [SendVerificationCodeForBindSecureMobilePhone](~~372556~~) operation to obtain the verification code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'SecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number that you want to bind to the member for security purposes.'."\n" + ."\n" + .'The mobile phone number you specify must be the same as the mobile phone number that you specify when you call the [SendVerificationCodeForBindSecureMobilePhone](~~372556~~) operation to obtain a verification code.'."\n" + ."\n" + .'Specify the mobile phone number in the \\<Country code>-\\<Mobile phone number> format.'."\n" + ."\n" + .'> Mobile phone numbers in the `86-<Mobile phone number>` format in the Chinese mainland are not supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xx-13900001234', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '138660628348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0217AFEB-5318-56D4-B167-1933D83EDF3F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotSupport.Site.Action', + 'errorMessage' => 'Site does not allow current action.', + ], + ], + 409 => [ + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified account is an Alibaba Cloud account or already exists in another resource directory.', + ], + [ + 'errorCode' => 'Invalid.EnterpriseName', + 'errorMessage' => 'You must specify the enterprise name.', + ], + [ + 'errorCode' => 'EnterpriseRealNameVerificationError', + 'errorMessage' => 'The specified account does not pass enterprise real-name verification. We recommend you first complete enterprise real-name verification for the account.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.', + ], + [ + 'errorCode' => 'Invalid.VerificationCode', + 'errorMessage' => 'The verification code is invalid.', + ], + [ + 'errorCode' => 'AccountTypeMismatch', + 'errorMessage' => 'The type or status of the member account cannot satisfy the current operation.', + ], + [ + 'errorCode' => 'AccountSecureMobileAlreadyExists', + 'errorMessage' => 'The secure mobile number of the member already exists.', + ], + [ + 'errorCode' => 'CallerIdentityError', + 'errorMessage' => 'Please use the RAM user or role of the Management Account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0217AFEB-5318-56D4-B167-1933D83EDF3F\\"\\n}","errorExample":""},{"type":"xml","example":"<BindSecureMobilePhoneResponse>\\n <RequestId>0217AFEB-5318-56D4-B167-1933D83EDF3F</RequestId>\\n</BindSecureMobilePhoneResponse>","errorExample":""}]', + 'title' => 'BindSecureMobilePhone', + 'description' => 'You can call this API operation only to bind a mobile phone number to a member of the resource account type. You cannot call this API operation to change the mobile phone number that is bound to a member of the resource account type.'."\n" + ."\n" + .'To ensure that the system can record the operators of management operations, you must use a RAM user or RAM role to which the AliyunResourceDirectoryFullAccess policy is attached within the management account of your resource directory to call this API operation.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to bind a mobile phone number to the member `138660628348****` for security purposes.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'SendVerificationCodeForBindSecureMobilePhone' => [ + 'summary' => 'Sends a verification code to the mobile phone number that you want to bind to a resource account in a resource directory for security purposes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number that you want to bind to the resource account.'."\n" + ."\n" + .'Specify the mobile phone number in the \\<Country code>-\\<Mobile phone number> format.'."\n" + ."\n" + .'> Mobile phone numbers in the `86-<Mobile phone number>` format in the Chinese mainland are not supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xx-13900001234', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '138660628348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DCD43660-75DD-5D15-B342-1B83FCA5B913', + ], + 'ExpirationDate' => [ + 'description' => 'The time when the verification code expires.'."\n", + 'type' => 'string', + 'example' => '2021-12-17T07:38:41.747Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified account is an Alibaba Cloud account or already exists in another resource directory.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.', + ], + [ + 'errorCode' => 'SendValidateCodeExceedsLimitForAccount', + 'errorMessage' => 'For the same account, the number of verification codes sent exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter.MobileCountryCode', + 'errorMessage' => 'The current site does not support the country code.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DCD43660-75DD-5D15-B342-1B83FCA5B913\\",\\n \\"ExpirationDate\\": \\"2021-12-17T07:38:41.747Z\\"\\n}","errorExample":""},{"type":"xml","example":"<SendVerificationCodeForBindSecureMobilePhoneResponse>\\n <RequestId>DCD43660-75DD-5D15-B342-1B83FCA5B913</RequestId>\\n <ExpirationDate>2021-12-17T07:38:41.747Z</ExpirationDate>\\n</SendVerificationCodeForBindSecureMobilePhoneResponse>","errorExample":""}]', + 'title' => 'SendVerificationCodeForBindSecureMobilePhone', + 'description' => 'To ensure that the system can record the operators of management operations, you must use a RAM user or RAM role to which the AliyunResourceDirectoryFullAccess policy is attached within the management account of your resource directory to call this operation.'."\n" + ."\n" + .'In this example, a verification code is sent to the mobile phone number that you want to bind to the resource account `138660628348****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'ChangeAccountEmail' => [ + 'summary' => 'Changes the email address that is bound to a member.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address to be bound to the member.'."\n" + ."\n" + .'> The system automatically sends a verification email to the email address. After the verification is passed, the email address takes effect, and the system changes both the logon email address and secure email address of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotSupportedOperation.Account.EmailModify', + 'errorMessage' => 'The operation is not supported because the account email is being modifying.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeAccountEmailResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n</ChangeAccountEmailResponse>","errorExample":""}]', + 'title' => 'ChangeAccountEmail', + ], + 'RetryChangeAccountEmail' => [ + 'summary' => 'Resends a verification email for the email address change of a member.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.EmailModifyRecord', + 'errorMessage' => 'This email modification record of the account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<RetryChangeAccountEmailResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n</RetryChangeAccountEmailResponse>","errorExample":""}]', + 'title' => 'RetryChangeAccountEmail', + ], + 'CancelChangeAccountEmail' => [ + 'summary' => 'Cancels the email address change of a member.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.EmailModifyRecord', + 'errorMessage' => 'This email modification record of the account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelChangeAccountEmailResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n</CancelChangeAccountEmailResponse>","errorExample":""}]', + 'title' => 'CancelChangeAccountEmail', + ], + 'CheckAccountDelete' => [ + 'summary' => 'Performs a member deletion check.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '179855839641****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7CDDDCEF-CDFD-0825-B7D7-217BE0897B22', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + [ + 'errorCode' => 'InvalidControlPolicyEnablementStatus', + 'errorMessage' => 'The control policy enablement status is not valid to perform this operation.', + ], + [ + 'errorCode' => 'NoLicense.ResourceDirectory', + 'errorMessage' => 'The resource directory has not enabled the delete operation.', + ], + [ + 'errorCode' => 'UnknownError.Account', + 'errorMessage' => 'The deletion failed. An unknown error occurred. Please try again later.', + ], + [ + 'errorCode' => 'CallerIdentityError.DeleteAccount', + 'errorMessage' => 'Please use the RAM user or role of the management account to delete.', + ], + [ + 'errorCode' => 'RemoveConfilctAccountAsDelegatedAdministator', + 'errorMessage' => 'You attempted to remove a member that is registered as a delegated administrator. To complete this operation, you must first deregister this account as a delegated administrator.', + ], + [ + 'errorCode' => 'LegalEntityDifferent', + 'errorMessage' => 'The account legal entity is different from the one of the Management Account.', + ], + [ + 'errorCode' => 'MemberTypeError.DeleteAccount', + 'errorMessage' => 'You can only delete accounts of the resource account type created by Resource Directory.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CDDDCEF-CDFD-0825-B7D7-217BE0897B22\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckAccountDeleteResponse>\\n <RequestId>7CDDDCEF-CDFD-0825-B7D7-217BE0897B22</RequestId>\\n</CheckAccountDeleteResponse>","errorExample":""}]', + 'title' => 'CheckAccountDelete', + 'description' => 'Before you delete a member, you must call this API operation to check whether the member can be deleted.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to perform a deletion check on the member whose ID is `179855839641****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'DeleteAccount' => [ + 'summary' => 'Deletes a member of the resource account type.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '169946124551****', + ], + ], + [ + 'name' => 'AbandonableCheckId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The ID of a check item that you can choose to ignore for the member deletion.'."\n" + ."\n" + .'You can obtain the ID from the response of the [GetAccountDeletionCheckResult](~~448775~~) operation.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a check item that you can choose to ignore for the member deletion.'."\n" + ."\n" + .'You can obtain the ID from the response of the [GetAccountDeletionCheckResult](~~448775~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NON_SP_cs', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '009429F8-C1C0-5872-B674-A6C2333B9647', + ], + 'DeletionType' => [ + 'description' => 'The type of the deletion. Valid values:'."\n" + ."\n" + .'* 0: Direct deletion. If the member does not have pay-as-you-go resources that are purchased within the previous 30 days, the system directly deletes the member.'."\n" + .'* 1: Deletion with a silence period. If the member has pay-as-you-go resources that are purchased within the previous 30 days, the member enters a silence period. The system starts to delete the member until the silence period ends. For more information about the silence period, see [What is the silence period for member deletion?](~~446079~~)'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountNotExist.DeleteAccount', + 'errorMessage' => 'The deletion failed. The account does not exist. Please confirm whether it has been deleted.', + ], + [ + 'errorCode' => 'InvalidControlPolicyEnablementStatus', + 'errorMessage' => 'The control policy enablement status is not valid to perform this operation.', + ], + [ + 'errorCode' => 'NoLicense.ResourceDirectory', + 'errorMessage' => 'The resource directory has not enabled the delete operation.', + ], + [ + 'errorCode' => 'CallerIdentityError.DeleteAccount', + 'errorMessage' => 'Please use the RAM user or role of the management account to delete.', + ], + [ + 'errorCode' => 'RemoveConfilctAccountAsDelegatedAdministator', + 'errorMessage' => 'You attempted to remove a member that is registered as a delegated administrator. To complete this operation, you must first deregister this account as a delegated administrator.', + ], + [ + 'errorCode' => 'LegalEntityDifferent', + 'errorMessage' => 'The account legal entity is different from the one of the Management Account.', + ], + [ + 'errorCode' => 'MemberTypeError.DeleteAccount', + 'errorMessage' => 'You can only delete accounts of the resource account type created by Resource Directory.', + ], + [ + 'errorCode' => 'NotSupport.HasPayerAccount', + 'errorMessage' => 'This account has a payer account. Please release the financial relationship of this account first.', + ], + [ + 'errorCode' => 'NotSupportedOperation.DeletingAccount', + 'errorMessage' => 'The operation is not supported because the account is being deleted.', + ], + [ + 'errorCode' => 'NotSupportedOperation.CheckingAccount', + 'errorMessage' => 'The operation is not supported because the account is checking for deletion.', + ], + [ + 'errorCode' => 'UnknownError.Account', + 'errorMessage' => 'The deletion failed. An unknown error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"009429F8-C1C0-5872-B674-A6C2333B9647\\",\\n \\"DeletionType\\": \\"0\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccountResponse>\\n <RequestId>55B22096-0D0C-542D-9A01-9B95977D3A10</RequestId>\\n <DeletionType>0</DeletionType>\\n</DeleteAccountResponse>","errorExample":""}]', + 'title' => 'DeleteAccount', + 'description' => 'Before you delete a member, we recommend that you call the [CheckAccountDelete](~~448542~~) and [GetAccountDeletionCheckResult](~~448775~~) operations to check whether the member meets deletion requirements. You can call the DeleteAccount operation to delete only members that meet the deletion requirements.'."\n" + ."\n" + .'After you submit a deletion request for a member, you can call the [GetAccountDeletionStatus](~~449001~~) operation to query the deletion status of the member. After a member is deleted, the resources and data within the member are deleted, and you can no longer use the member to log on to the Alibaba Cloud Management Console. In addition, the member cannot be recovered. Proceed with caution. For more information about how to delete a member, see [Delete a member of the resource account type](~~446078~~).'."\n", + 'requestParamsDescription' => 'The IDs of the check items that you can choose to ignore for the member deletion.'."\n" + ."\n" + .'You can obtain the IDs from the response of the [GetAccountDeletionCheckResult](~~448775~~) operation.'."\n", + ], + 'SetMemberDeletionPermission' => [ + 'summary' => 'Enables or disables the member deletion feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the member deletion feature. Valid values:'."\n" + ."\n" + .'* Enabled: enables the member deletion feature'."\n" + .'* Disabled: disables the member deletion feature'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C55A4CAA-9039-1DDF-91CE-FCC134513D29', + ], + 'MemberDeletionStatus' => [ + 'description' => 'The status of the member deletion feature. Valid values:'."\n" + ."\n" + .'* Enabled: The feature is enabled.'."\n" + .'* Disabled: The feature is disabled.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'ManagementAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => 'The specified Status is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MemberAccountAccessDenied', + 'errorMessage' => 'The member account is not allowed to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C55A4CAA-9039-1DDF-91CE-FCC134513D29\\",\\n \\"MemberDeletionStatus\\": \\"Enabled\\",\\n \\"ManagementAccountId\\": \\"151266687691****\\",\\n \\"ResourceDirectoryId\\": \\"rd-3G****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetMemberDeletionPermissionResponse>\\n <ResourceDirectoryId>rd-3G****</ResourceDirectoryId>\\n <RequestId>C55A4CAA-9039-1DDF-91CE-FCC134513D29</RequestId>\\n <MemberDeletionStatus>Enabled</MemberDeletionStatus>\\n <ManagementAccountId>151266687691****</ManagementAccountId>\\n</SetMemberDeletionPermissionResponse>","errorExample":""}]', + 'title' => 'SetMemberDeletionPermission', + 'description' => 'Members of the resource account type can be deleted only after the member deletion feature is enabled.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'GetAccountDeletionStatus' => [ + 'summary' => '获取账号删除状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '169946124551****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RdAccountDeletionStatus' => [ + 'description' => 'The deletion status of the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status. Valid values:'."\n" + ."\n" + .'* Success: The member is deleted.'."\n" + .'* Checking: A deletion check is being performed for the member.'."\n" + .'* Deleting: The member is being deleted.'."\n" + .'* CheckFailed: The deletion check for the member fails.'."\n" + .'* DeleteFailed: The member fails to be deleted.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'AccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the member.'."\n", + 'type' => 'string', + 'example' => '169946124551****', + ], + 'CreateTime' => [ + 'description' => 'The start time of the deletion.'."\n", + 'type' => 'string', + 'example' => '2022-08-23T17:05:30+08:00', + ], + 'DeletionTime' => [ + 'description' => 'The end time of the deletion.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-23T17:06:01+08:00', + ], + 'FailReasonList' => [ + 'description' => 'The reasons why the member fails to be deleted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The reasons why the member fails to be deleted.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the cloud service to which the check item belongs.'."\n", + 'type' => 'string', + 'example' => 'Others', + ], + 'Description' => [ + 'description' => 'The description of the check item.'."\n", + 'type' => 'string', + 'example' => 'This account has a payer account. Please release the financial relationship of this account first.', + ], + ], + ], + ], + 'DeletionType' => [ + 'description' => 'The type of the deletion. Valid values:'."\n" + ."\n" + .'* 0: direct deletion. If the member does not have pay-as-you-go resources that are purchased within the previous 30 days, the system directly deletes the member.'."\n" + .'* 1: deletion with a silence period. If the member has pay-as-you-go resources that are purchased within the previous 30 days, the member enters a silence period. The system starts to delete the member until the silence period ends. For more information about the silence period, see [What is the silence period for member deletion?](~~446079~~)'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8AA43293-7C8F-5730-8F2D-7F864EC092C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'EntityNotExists.CheckAccount', + 'errorMessage' => 'There is no check task for this account', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RdAccountDeletionStatus\\": {\\n \\"Status\\": \\"Success\\",\\n \\"AccountId\\": \\"169946124551****\\",\\n \\"CreateTime\\": \\"2022-08-23T17:05:30+08:00\\",\\n \\"DeletionTime\\": \\"2022-08-23T17:06:01+08:00\\",\\n \\"FailReasonList\\": [\\n {\\n \\"Name\\": \\"Others\\",\\n \\"Description\\": \\"This account has a payer account. Please release the financial relationship of this account first.\\"\\n }\\n ],\\n \\"DeletionType\\": \\"0\\"\\n },\\n \\"RequestId\\": \\"8AA43293-7C8F-5730-8F2D-7F864EC092C5\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAccountDeletionStatusResponse>\\n <RequestId>8AA43293-7C8F-5730-8F2D-7F864EC092C5</RequestId>\\n <RdAccountDeletionStatus>\\n <Status>Success</Status>\\n <AccountId>169946124551****</AccountId>\\n <DeletionType>0</DeletionType>\\n <CreateTime>2022-08-23T17:05:30+08:00</CreateTime>\\n <DeletionTime>2022-08-23T17:06:01+08:00</DeletionTime>\\n </RdAccountDeletionStatus>\\n</GetAccountDeletionStatusResponse>","errorExample":""}]', + 'title' => 'GetAccountDeletionStatus', + 'description' => 'This topic provides an example on how to call the API operation to query the deletion status of the member whose Alibaba Cloud account ID is `169946124551****`. The response shows that the member is deleted.', + ], + 'GetAccountDeletionCheckResult' => [ + 'summary' => 'Queries the result of a member deletion check.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '179855839641****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '54AC391D-4F7F-5F08-B8D3-0AECDE6EC5BD', + ], + 'AccountDeletionCheckResultInfo' => [ + 'description' => 'The result of the deletion check for the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the check. Valid values:'."\n" + ."\n" + .'* PreCheckComplete: The check is complete.'."\n" + .'* PreChecking: The check is in progress.'."\n", + 'type' => 'string', + 'example' => 'PreCheckComplete', + ], + 'AllowDelete' => [ + 'description' => 'Indicates whether the member can be deleted. Valid values:'."\n" + ."\n" + .'* true: The member can be deleted.'."\n" + .'* false: The member cannot be deleted.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'NotAllowReason' => [ + 'description' => 'The reasons why the member cannot be deleted.'."\n" + ."\n" + .'> This parameter is returned only if the value of AllowDelete is false.', + 'type' => 'array', + 'items' => [ + 'description' => 'The reasons why the member cannot be deleted.'."\n" + ."\n" + .'> This parameter is returned only if the value of AllowDelete is false.', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the check item.'."\n", + 'type' => 'string', + 'example' => 'This account is an Enterprise Finance associated account. Please remove the financial association of this account before deleting it.', + ], + 'CheckId' => [ + 'description' => 'The ID of the check item.'."\n", + 'type' => 'string', + 'example' => 'NON_SP_efc', + ], + 'CheckName' => [ + 'description' => 'The name of the cloud service to which the check item belongs.'."\n", + 'type' => 'string', + 'example' => 'Enterprise finance', + ], + ], + ], + ], + 'AbandonableChecks' => [ + 'description' => 'The check items that you can choose to ignore for the member deletion.'."\n" + ."\n" + .'> This parameter may be returned if the value of AllowDelete is true.', + 'type' => 'array', + 'items' => [ + 'description' => 'The check items that you can choose to ignore for the member deletion.'."\n" + ."\n" + .'> This parameter may be returned if the value of AllowDelete is true.', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the check item.'."\n", + 'type' => 'string', + 'example' => 'An instance of a cloud service is running within the member. Submit a ticket to contact Alibaba Cloud technical support.', + ], + 'CheckId' => [ + 'description' => 'The ID of the check item.'."\n", + 'type' => 'string', + 'example' => 'NON_SP_cs', + ], + 'CheckName' => [ + 'description' => 'The name of the cloud service to which the check item belongs.'."\n", + 'type' => 'string', + 'example' => 'Container Service for Kubernetes', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + [ + 'errorCode' => 'EntityNotExists.CheckAccount', + 'errorMessage' => 'There is no check task for this account', + ], + [ + 'errorCode' => 'UnknownError.Account', + 'errorMessage' => 'The deletion failed. An unknown error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54AC391D-4F7F-5F08-B8D3-0AECDE6EC5BD\\",\\n \\"AccountDeletionCheckResultInfo\\": {\\n \\"Status\\": \\"PreCheckComplete\\",\\n \\"AllowDelete\\": \\"false\\",\\n \\"NotAllowReason\\": [\\n {\\n \\"Description\\": \\"This account is an Enterprise Finance associated account. Please remove the financial association of this account before deleting it.\\",\\n \\"CheckId\\": \\"NON_SP_efc\\",\\n \\"CheckName\\": \\"Enterprise finance\\"\\n }\\n ],\\n \\"AbandonableChecks\\": [\\n {\\n \\"Description\\": \\"存在云产品实例运行,请联系客服人员提工单处理。\\",\\n \\"CheckId\\": \\"NON_SP_cs\\",\\n \\"CheckName\\": \\"容器服务\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountDeletionCheckResultResponse>\\n <AccountDeletionCheckResultInfo>\\n <Status>PreCheckComplete</Status>\\n <NotAllowReason>\\n <Description>instance number:1</Description>\\n <CheckName>eip_pre</CheckName>\\n <CheckId>SP_eip_eip_pre</CheckId>\\n </NotAllowReason>\\n <NotAllowReason>\\n <Description>This account is an Enterprise Finance associated account. Please remove the financial association of this account before deleting it.</Description>\\n <CheckName>Enterprise finance</CheckName>\\n <CheckId>NON_SP_efc</CheckId>\\n </NotAllowReason>\\n <AllowDelete>false</AllowDelete>\\n </AccountDeletionCheckResultInfo>\\n <RequestId>54AC391D-4F7F-5F08-B8D3-0AECDE6EC5BD</RequestId>\\n</GetAccountDeletionCheckResultResponse>","errorExample":""}]', + 'title' => 'GetAccountDeletionCheckResult', + 'description' => 'After you call the [CheckAccountDelete](~~448542~~) operation to perform a member deletion check, you can call the GetAccountDeletionCheckResult operation to query the check result. If the check result shows that the member meets deletion requirements, you can delete the member. Otherwise, you need to first modify the items that do not meet requirements.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the result of the deletion check for the member whose ID is `179855839641****`. The response shows that the member does not meet deletion requirements.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'InviteAccountToResourceDirectory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TargetEntity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID or logon email address of the account that you want to invite.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Email', + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => 'The comment on the invitation.'."\n" + ."\n" + .'The comment can be up to 1,024 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Welcome', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tag key and value.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key and value.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => 'The information of the invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation.'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expires.'."\n", + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => 'The comment on the invitation.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => 'The type of the invited account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.TargetEntity', + 'errorMessage' => 'You must specify TargetEntity.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetEntity', + 'errorMessage' => 'The TargetEntity is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.TargetType', + 'errorMessage' => 'You must specify TargetType.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetType', + 'errorMessage' => 'The TargetType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Note.Length', + 'errorMessage' => 'The length of the invitation note exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter.Note', + 'errorMessage' => 'The Note is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.Account', + 'errorMessage' => 'The maximum number of member accounts in a resource directory exceeds the limit.', + ], + [ + 'errorCode' => 'LimitExceeded.InvitationRate', + 'errorMessage' => 'The number of invitations sent exceeds the limit.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.Handshake', + 'errorMessage' => 'Handshakes with the same target entity already exist.', + ], + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'Your account is a management account for another resource directory or a member of another resource directory.', + ], + [ + 'errorCode' => 'LegalEntityMismatch', + 'errorMessage' => 'Your account does not have the same legal entity as the master account.', + ], + [ + 'errorCode' => 'Invalid.AccountType', + 'errorMessage' => 'The specified profile type of account is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"Handshake\\": {\\n \\"Status\\": \\"Pending\\",\\n \\"ExpireTime\\": \\"2018-08-24T09:55:41Z\\",\\n \\"ResourceDirectoryId\\": \\"rd-abcdef****\\",\\n \\"CreateTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"TargetEntity\\": \\"[email protected]\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"MasterAccountName\\": \\"Alice\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"HandshakeId\\": \\"h-ycm4rp****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<InviteAccountToResourceDirectoryResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n <Handshake>\\n <HandshakeId>h-ycm4rp****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>Alice</MasterAccountName>\\n <TargetEntity>[email protected]</TargetEntity>\\n <TargetType>Email</TargetType>\\n <Note>欢迎您加入</Note>\\n <Status>Pending</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n</InviteAccountToResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'InviteAccountToResourceDirectory', + 'summary' => 'Invites an account to join a resource directory.', + 'description' => 'This topic provides an example on how to call the API operation to invite the account `[email protected]` to join a resource directory.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetHandshake' => [ + 'summary' => 'Queries the information of an invitation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'h-ycm4rp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => 'The information of the invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expires.'."\n", + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + 'MasterAccountRealName' => [ + 'description' => 'The real-name verification information of the management account of the resource directory.'."\n" + ."\n" + .'> This parameter is available only when an invitee calls this operation.'."\n", + 'type' => 'string', + 'example' => 'company', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'InvitedAccountRealName' => [ + 'description' => 'The real-name verification information of the invitee.'."\n" + ."\n" + .'> This parameter is available only when an invitee calls this operation.'."\n", + 'type' => 'string', + 'example' => 'Alice', + ], + 'Note' => [ + 'description' => 'The comment on the invitation.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'TargetType' => [ + 'description' => 'The type of the invited account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'example' => 'Email', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.HandshakeId', + 'errorMessage' => 'You must specify HandshakeId.', + ], + [ + 'errorCode' => 'InvalidParameter.HandshakeId', + 'errorMessage' => 'The HandshakeId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Handshake', + 'errorMessage' => 'The specified handshake does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'HandshakeStatusMismatch', + 'errorMessage' => 'The invitation is invalid.', + ], + [ + 'errorCode' => 'MissingAccountRealName', + 'errorMessage' => 'The name of the invited account is not specified.', + ], + [ + 'errorCode' => 'NoRealNameAuthentication', + 'errorMessage' => 'The account invited has not passed real-name authentication.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"Handshake\\": {\\n \\"Status\\": \\"Pending\\",\\n \\"ExpireTime\\": \\"2018-08-24T09:55:41Z\\",\\n \\"CreateTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"TargetEntity\\": \\"[email protected]\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"HandshakeId\\": \\"h-ycm4rp****\\",\\n \\"MasterAccountRealName\\": \\"company\\",\\n \\"ResourceDirectoryId\\": \\"rd-abcdef****\\",\\n \\"InvitedAccountRealName\\": \\"Alice\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"MasterAccountName\\": \\"[email protected]\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHandshakeResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n <Handshake>\\n <HandshakeId>h-ycm4rp****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>[email protected]</MasterAccountName>\\n <MasterAccountRealName>company</MasterAccountRealName>\\n <InvitedAccountRealName>Alice</InvitedAccountRealName>\\n <TargetEntity>[email protected]</TargetEntity>\\n <TargetType>Email</TargetType>\\n <Note>欢迎您加入</Note>\\n <Status>Pending</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n</GetHandshakeResponse>","errorExample":""}]', + 'title' => 'GetHandshake', + 'description' => 'In this example, the information of the invitation whose ID is `h-ycm4rp****` is queried.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelHandshake' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'h-ycm4rp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => 'The information of the invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expires.'."\n", + 'type' => 'string', + 'example' => 'Cancelled', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => 'The comment on the invitation.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => 'The type of the invited account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.HandshakeId', + 'errorMessage' => 'You must specify HandshakeId.', + ], + [ + 'errorCode' => 'InvalidParameter.HandshakeId', + 'errorMessage' => 'The HandshakeId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Handshake', + 'errorMessage' => 'The specified handshake does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'HandshakeStatusMismatch', + 'errorMessage' => 'The invitation is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"Handshake\\": {\\n \\"Status\\": \\"Cancelled\\",\\n \\"ExpireTime\\": \\"2018-08-24T09:55:41Z\\",\\n \\"ResourceDirectoryId\\": \\"h-ycm4rp****\\",\\n \\"CreateTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"TargetEntity\\": \\"[email protected]\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"MasterAccountName\\": \\"Alice\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"HandshakeId\\": \\"h-ycm4rp****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelHandshakeResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n <Handshake>\\n <HandshakeId>h-ycm4rp****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>Alice</MasterAccountName>\\n <TargetEntity>[email protected]</TargetEntity>\\n <TargetType>Email</TargetType>\\n <Note>欢迎您加入</Note>\\n <Status>Cancelled</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n</CancelHandshakeResponse>","errorExample":""}]', + 'title' => 'CancelHandshake', + 'summary' => 'Cancels an invitation.', + 'description' => 'This topic provides an example on how to call the API operation to cancel the invitation whose ID is `h-ycm4rp****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'extraInfo' => ' ', + ], + 'ListHandshakesForAccount' => [ + 'summary' => 'Queries the invitations that are associated with an account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of invitations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Handshakes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Handshake' => [ + 'description' => 'The information of the invitations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the invitations.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expires.'."\n", + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => 'The comment on the invitation.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'CompanyA', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => 'The type of the invited Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-4N57QZzCTtES****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Handshakes\\": {\\n \\"Handshake\\": [\\n {\\n \\"Status\\": \\"Pending\\",\\n \\"ExpireTime\\": \\"2018-08-24T09:55:41Z\\",\\n \\"ResourceDirectoryId\\": \\"rd-abcdef****\\",\\n \\"CreateTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"TargetEntity\\": \\"[email protected]\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"MasterAccountName\\": \\"CompanyA\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"HandshakeId\\": \\"h-4N57QZzCTtES****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListHandshakesForAccountResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>2</TotalCount>\\n <Handshakes>\\n <Handshake>\\n <HandshakeId>h-4N57QZzCTtES****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>CompanyA</MasterAccountName>\\n <TargetEntity>[email protected]</TargetEntity>\\n <TargetType>Email</TargetType>\\n <Note>欢迎您加入</Note>\\n <Status>Pending</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n <Handshake>\\n <HandshakeId>h-BeJZW63fHT4l****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>CompanyA</MasterAccountName>\\n <TargetEntity>172841235500****</TargetEntity>\\n <TargetType>Account</TargetType>\\n <Note>欢迎您加入</Note>\\n <Status>Pending</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n </Handshakes>\\n</ListHandshakesForAccountResponse>","errorExample":""}]', + 'title' => 'ListHandshakesForAccount', + 'description' => 'This topic provides an example on how to call the API operation to query the invitations that are associated with the management account `172841235500****`. The response shows that two invitations are associated with the management account.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListHandshakesForResourceDirectory' => [ + 'summary' => 'Queries invitations in a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Handshakes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Handshake' => [ + 'description' => 'The information of the invitations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the invitations.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expires.'."\n", + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => 'The comment on the invitation.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => 'The type of the invited account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Handshakes\\": {\\n \\"Handshake\\": [\\n {\\n \\"Status\\": \\"Pending\\",\\n \\"ExpireTime\\": \\"2018-08-24T09:55:41Z\\",\\n \\"ResourceDirectoryId\\": \\"rd-abcdef****\\",\\n \\"CreateTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"TargetEntity\\": \\"[email protected]\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"MasterAccountName\\": \\"Alice\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"HandshakeId\\": \\"h-ycm4rp****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListHandshakesForResourceDirectoryResponse>\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>2</TotalCount>\\n <Handshakes>\\n <Handshake>\\n <HandshakeId>h-ycm4rp****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>Alice</MasterAccountName>\\n <InviteEntity>[email protected]</InviteEntity>\\n <InviteType>Email</InviteType>\\n <Note>欢迎您加入</Note>\\n <Status>Pending</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n <Handshake>\\n <HandshakeId>h-ycm4rp****</HandshakeId>\\n <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\n <MasterAccountId>172841235500****</MasterAccountId>\\n <MasterAccountName>Alice</MasterAccountName>\\n <TargetEntity>172841235500****</TargetEntity>\\n <TargetType>Account</TargetType>\\n <Note>欢迎您加入</Note>\\n <Status>Pending</Status>\\n <CreateTime>2018-08-10T09:55:41Z</CreateTime>\\n <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\n <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>\\n </Handshake>\\n </Handshakes>\\n</ListHandshakesForResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'ListHandshakesForResourceDirectory', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AcceptHandshake' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the invitation.'."\n" + ."\n" + .'You can call the [ListHandshakesForAccount](~~160006~~) operation to obtain the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'h-Ih8IuPfvV0t0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5828C836-3286-49A6-9006-15231BB19342', + ], + 'Handshake' => [ + 'description' => 'The information of the invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expires.'."\n", + 'type' => 'string', + 'example' => 'Accepted', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-20T02:15:40Z', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-06T02:15:40Z', + ], + 'Note' => [ + 'description' => 'The comment on the invitation.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '177242285274****', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'CompanyA', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-06T02:16:40Z', + ], + 'TargetType' => [ + 'description' => 'The type of the invited Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the Alibaba Cloud account.'."\n" + .'* Email: indicates the logon email address of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => 'Account', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-Ih8IuPfvV0t0****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.HandshakeId', + 'errorMessage' => 'You must specify HandshakeId.', + ], + [ + 'errorCode' => 'InvalidParameter.HandshakeId', + 'errorMessage' => 'The HandshakeId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Handshake', + 'errorMessage' => 'The specified handshake does not exist.', + ], + [ + 'errorCode' => 'SpecifiedResourceDirectoryNotExists', + 'errorMessage' => 'The specified resource directory does not exist. You must specify a valid resource directory.', + ], + ], + 409 => [ + [ + 'errorCode' => 'HandshakeStatusMismatch', + 'errorMessage' => 'The invitation is invalid.', + ], + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'Your account is a management account for another resource directory or a member of another resource directory.', + ], + [ + 'errorCode' => 'Invalid.AccountType', + 'errorMessage' => 'The specified profile type of account is invalid.', + ], + [ + 'errorCode' => 'NotSupport.Account.RealNameType', + 'errorMessage' => 'Your account is not a real-name of enterprise type, so you cannot accept the invitation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5828C836-3286-49A6-9006-15231BB19342\\",\\n \\"Handshake\\": {\\n \\"Status\\": \\"Accepted\\",\\n \\"ExpireTime\\": \\"2021-01-20T02:15:40Z\\",\\n \\"ResourceDirectoryId\\": \\"rd-3G****\\",\\n \\"CreateTime\\": \\"2021-01-06T02:15:40Z\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"TargetEntity\\": \\"177242285274****\\",\\n \\"MasterAccountId\\": \\"151266687691****\\",\\n \\"MasterAccountName\\": \\"CompanyA\\",\\n \\"ModifyTime\\": \\"2021-01-06T02:16:40Z\\",\\n \\"TargetType\\": \\"Account\\",\\n \\"HandshakeId\\": \\"h-Ih8IuPfvV0t0****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AcceptHandshakeResponse>\\n <RequestId>5828C836-3286-49A6-9006-15231BB19342</RequestId>\\n <Handshake>\\n <Status>Accepted</Status>\\n <ModifyTime>2021-01-06T02:16:40Z</ModifyTime>\\n <ResourceDirectoryId>rd-3G****</ResourceDirectoryId>\\n <HandshakeId>h-Ih8IuPfvV0t0****</HandshakeId>\\n <Note>欢迎您加入</Note>\\n <CreateTime>2021-01-06T02:15:40Z</CreateTime>\\n <TargetType>Account</TargetType>\\n <MasterAccountId>151266687691****</MasterAccountId>\\n <MasterAccountName>CompanyA</MasterAccountName>\\n <ExpireTime>2021-01-20T02:15:40Z</ExpireTime>\\n <TargetEntity>177242285274****</TargetEntity>\\n </Handshake>\\n</AcceptHandshakeResponse>","errorExample":""}]', + 'title' => 'AcceptHandshake', + 'summary' => 'Accepts an invitation.', + 'description' => 'After an invited Alibaba Cloud account joins a resource directory, it becomes a member of the resource directory. By default, the name of the invited Alibaba Cloud account is used as the display name of the account in the resource directory.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to accept the invitation `h-Ih8IuPfvV0t0****` that is initiated to invite the Alibaba Cloud account `177242285274****` to join the resource directory `rd-3G****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeclineHandshake' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'h-ycm4rp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => 'The information of the invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Declined: The invitation is rejected.'."\n" + .'* Expired: The invitation expired.'."\n", + 'type' => 'string', + 'example' => 'Declined', + ], + 'ExpireTime' => [ + 'description' => 'The time when the invitation expires.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => 'The invitation note.'."\n", + 'type' => 'string', + 'example' => 'Welcome', + ], + 'TargetEntity' => [ + 'description' => 'The ID or logon email address of the invited account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the enterprise management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the enterprise management account of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => 'The time when the invitation was modified.'."\n", + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => 'The type of the invited account. Valid values:'."\n" + ."\n" + .'* Account: indicates the ID of the account.'."\n" + .'* Email: indicates the logon email address of the account.'."\n", + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.HandshakeId', + 'errorMessage' => 'You must specify HandshakeId.', + ], + [ + 'errorCode' => 'InvalidParameter.HandshakeId', + 'errorMessage' => 'The HandshakeId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Handshake', + 'errorMessage' => 'The specified handshake does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'HandshakeStatusMismatch', + 'errorMessage' => 'The invitation is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"Handshake\\": {\\n \\"Status\\": \\"Declined\\",\\n \\"ExpireTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"ResourceDirectoryId\\": \\"rd-abcdef****\\",\\n \\"CreateTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"TargetEntity\\": \\"[email protected]\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"MasterAccountName\\": \\"Alice\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"HandshakeId\\": \\"h-ycm4rp****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeclineHandshakeResponse>\\r\\n\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n\\t<Handshake>\\r\\n\\t\\t<HandshakeId>h-ycm4rp****</HandshakeId>\\r\\n\\t\\t<ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>\\r\\n\\t\\t<MasterAccountId>172841235500****</MasterAccountId>\\r\\n\\t\\t<MasterAccountName>Alice</MasterAccountName>\\r\\n\\t\\t<TargetEntity>[email protected]</TargetEntity>\\r\\n\\t\\t<TargetType>Email</TargetType>\\r\\n\\t\\t<Note>欢迎您加入</Note>\\r\\n\\t\\t<Status>Declined</Status>\\r\\n\\t\\t<CreateTime>2018-08-10T09:55:41Z</CreateTime>\\r\\n\\t\\t<ModifyTime>2018-08-10T09:55:41Z</ModifyTime>\\r\\n\\t\\t<ExpireTime>2018-08-17T09:55:41Z7</ExpireTime>\\r\\n\\t</Handshake>\\r\\n</DeclineHandshakeResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DeclineHandshake', + 'summary' => 'Rejects an invitation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableControlPolicy' => [ + 'summary' => 'Enables the Control Policy feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnablementStatus' => [ + 'description' => 'The status of the Control Policy feature. Valid values:'."\n" + ."\n" + .'* Enabled: The Control Policy feature is enabled.'."\n" + .'* PendingEnable: The Control Policy feature is being enabled.'."\n" + .'* Disabled: The Control Policy feature is disabled.'."\n" + .'* PendingDisable: The Control Policy feature is being disabled.'."\n", + 'type' => 'string', + 'example' => 'PendingEnable', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8CE7BD95-EFFA-4911-A1E0-BD4412697FEB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'Throttling.EnableControlPolicy', + 'errorMessage' => 'The enable operation is too frequent. Please try again in %s minute(s).', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnablementStatus\\": \\"PendingEnable\\",\\n \\"RequestId\\": \\"8CE7BD95-EFFA-4911-A1E0-BD4412697FEB\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<EnableControlPolicyResponse>\\r\\n\\t<EnablementStatus>PendingEnable</EnablementStatus>\\r\\n\\t<RequestId>8CE7BD95-EFFA-4911-A1E0-BD4412697FEB</RequestId>\\r\\n</EnableControlPolicyResponse>","errorExample":""}]', + 'title' => 'EnableControlPolicy', + 'description' => 'The Control Policy feature allows you to manage the permission boundaries of the folders or member accounts in a resource directory in a centralized manner. This feature is implemented based on the resource directory. You can use this feature to develop common or dedicated rules for access control. The Control Policy feature does not grant permissions but only defines permission boundaries. A member account in a resource directory can be used to access resources only after it is granted the required permissions by using the Resource Access Management (RAM) service. For more information, see [Overview of the Control Policy feature](~~178671~~).'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetControlPolicyEnablementStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnablementStatus' => [ + 'description' => 'The status of the Control Policy feature. Valid values:'."\n" + ."\n" + .'* Enabled: The Control Policy feature is enabled.'."\n" + .'* PendingEnable: The Control Policy feature is being enabled.'."\n" + .'* Disabled: The Control Policy feature is disabled.'."\n" + .'* PendingDisable: The Control Policy feature is being disabled.'."\n", + 'type' => 'string', + 'example' => 'Disabled', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1DC39A4E-3B52-4EFE-9F93-4897D7FFA0C4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnablementStatus\\": \\"Disabled\\",\\n \\"RequestId\\": \\"1DC39A4E-3B52-4EFE-9F93-4897D7FFA0C4\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetControlPolicyEnablementStatusResponse>\\r\\n\\t<EnablementStatus>Disabled</EnablementStatus>\\r\\n\\t<RequestId>1DC39A4E-3B52-4EFE-9F93-4897D7FFA0C4</RequestId>\\r\\n</GetControlPolicyEnablementStatusResponse>","errorExample":""}]', + 'title' => 'GetControlPolicyEnablementStatus', + 'summary' => 'Queries the status of the Control Policy feature.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableControlPolicy' => [ + 'summary' => 'Disables the Control Policy feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnablementStatus' => [ + 'description' => 'The status of the Control Policy feature. Valid values:'."\n" + ."\n" + .'* Enabled: The Control Policy feature is enabled.'."\n" + .'* PendingEnable: The Control Policy feature is being enabled.'."\n" + .'* Disabled: The Control Policy feature is disabled.'."\n" + .'* PendingDisable: The Control Policy feature is being disabled.'."\n", + 'type' => 'string', + 'example' => 'PendingDisable', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C709979-451D-4C92-835D-7DDCCAA562E9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnablementStatus\\": \\"PendingDisable\\",\\n \\"RequestId\\": \\"7C709979-451D-4C92-835D-7DDCCAA562E9\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DisableControlPolicyResponse>\\r\\n\\t<EnablementStatus>PendingDisable</EnablementStatus>\\r\\n\\t<RequestId>7C709979-451D-4C92-835D-7DDCCAA562E9</RequestId>\\r\\n</DisableControlPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DisableControlPolicy', + 'description' => 'After you disable the Control Policy feature, the system automatically detaches all control policies that are attached to folders and member accounts. The system does not delete these control policies, but you cannot attach them to folders or member accounts again.'."\n" + ."\n" + .'> If you disable the Control Policy feature, the permissions of all folders and member accounts in a resource directory are affected. You must proceed with caution.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the access control policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length. The name can contain letters, digits, and hyphens (-) and must start with a letter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ExampleControlPolicy', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy.'."\n" + ."\n" + .'The description must be 1 to 1,024 characters in length. The description can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a letter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ExampleControlPolicy', + ], + ], + [ + 'name' => 'EffectScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective scope of the access control policy.'."\n" + ."\n" + .'The value RAM indicates that the access control policy takes effect only for RAM users and RAM roles.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RAM', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'The document of the access control policy.'."\n" + ."\n" + .'The document can be a maximum of 4,096 characters in length.'."\n" + ."\n" + .'For more information about the languages of access control policies, see [Languages of access control policies](~~179096~~).'."\n" + ."\n" + .'For more information about the examples of access control policies, see [Examples of custom access control policies](~~181474~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"Version":"1","Statement":[{"Effect":"Deny","Action":["ram:UpdateRole","ram:DeleteRole","ram:AttachPolicyToRole","ram:DetachPolicyFromRole"],"Resource":"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole"}]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ControlPolicy' => [ + 'description' => 'The details of the access control policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateDate' => [ + 'description' => 'The time when the access control policy was updated.'."\n", + 'type' => 'string', + 'example' => '2021-03-18T09:24:19Z', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => 'The effective scope of the access control policy.'."\n" + ."\n" + .'The value RAM indicates that the access control policy takes effect only for RAM users and RAM roles.'."\n", + 'type' => 'string', + 'example' => 'RAM', + ], + 'AttachmentCount' => [ + 'description' => 'The number of times that the access control policy is referenced.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'PolicyName' => [ + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'PolicyId' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'cp-jExXAqIYkwHN****', + ], + 'CreateDate' => [ + 'description' => 'The time when the access control policy was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-18T09:24:19Z', + ], + 'PolicyType' => [ + 'description' => 'The type of the access control policy. Valid values:'."\n" + ."\n" + .'* System: system access control policy'."\n" + .'* Custom: custom access control policy'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '776B05B3-A0B0-464B-A191-F4E1119A94B2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyDocument.Length', + 'errorMessage' => 'The maximum length of the policy document is exceeded. It must not exceed 4096 characters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ControlPolicy\\": {\\n \\"UpdateDate\\": \\"2021-03-18T09:24:19Z\\",\\n \\"Description\\": \\"ExampleControlPolicy\\",\\n \\"EffectScope\\": \\"RAM\\",\\n \\"AttachmentCount\\": \\"0\\",\\n \\"PolicyName\\": \\"ExampleControlPolicy\\",\\n \\"PolicyId\\": \\"cp-jExXAqIYkwHN****\\",\\n \\"CreateDate\\": \\"2021-03-18T09:24:19Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n },\\n \\"RequestId\\": \\"776B05B3-A0B0-464B-A191-F4E1119A94B2\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateControlPolicyResponse>\\r\\n\\t<ControlPolicy>\\r\\n\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t<UpdateDate>2021-03-18T09:24:19Z</UpdateDate>\\r\\n\\t\\t<Description>ExampleControlPolicy</Description>\\r\\n\\t\\t<AttachmentCount>0</AttachmentCount>\\r\\n\\t\\t<PolicyName>ExampleControlPolicy</PolicyName>\\r\\n\\t\\t<CreateDate>2021-03-18T09:24:19Z</CreateDate>\\r\\n\\t\\t<PolicyId>cp-jExXAqIYkwHN****</PolicyId>\\r\\n\\t\\t<EffectScope>RAM</EffectScope>\\r\\n\\t</ControlPolicy>\\r\\n\\t<RequestId>776B05B3-A0B0-464B-A191-F4E1119A94B2</RequestId>\\r\\n</CreateControlPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'CreateControlPolicy', + 'summary' => 'Creates a custom access control policy.', + 'description' => 'This topic provides an example on how to call the API operation to create a custom access control policy named `ExampleControlPolicy`. This access control policy is used to prohibit modifications to the ResourceDirectoryAccountAccessRole role and the permissions of the role.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cp-SImPt8GCEwiq****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the description of the access control policy. Valid values:'."\n" + ."\n" + .'* zh-CN (default value): Chinese'."\n" + .'* en: English'."\n" + .'* ja: Japanese'."\n" + ."\n" + .'> This parameter is valid only for system access control policies.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ControlPolicy' => [ + 'description' => 'The details of the access control policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'PolicyDocument' => [ + 'description' => 'The document of the access control policy.'."\n", + 'type' => 'string', + 'example' => '{\\"Version\\":\\"1\\",\\"Statement\\":[{\\"Effect\\":\\"Deny\\",\\"Action\\":[\\"ram:UpdateRole\\",\\"ram:DeleteRole\\",\\"ram:AttachPolicyToRole\\",\\"ram:DetachPolicyFromRole\\"],\\"Resource\\":\\"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole\\"}]}', + ], + 'UpdateDate' => [ + 'description' => 'The time when the access control policy was updated.'."\n", + 'type' => 'string', + 'example' => '2021-03-18T08:51:33Z', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => 'The effective scope of the access control policy. Valid values:'."\n" + ."\n" + .'* All: The access control policy is in effect for Alibaba Cloud accounts, RAM users, and RAM roles.'."\n" + .'* RAM: The access control policy is in effect only for RAM users and RAM roles.'."\n", + 'type' => 'string', + 'example' => 'RAM', + ], + 'AttachmentCount' => [ + 'description' => 'The number of times that the access control policy is referenced.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'PolicyName' => [ + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PolicyId' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'cp-SImPt8GCEwiq****', + ], + 'CreateDate' => [ + 'description' => 'The time when the access control policy was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-18T08:51:33Z', + ], + 'PolicyType' => [ + 'description' => 'The type of the access control policy. Valid values:'."\n" + ."\n" + .'* System: system access control policy'."\n" + .'* Custom: custom access control policy'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AB769936-CDFA-4D52-8CE2-A3581800044A', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ControlPolicy\\": {\\n \\"PolicyDocument\\": \\"{\\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Deny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"ram:UpdateRole\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ram:DeleteRole\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ram:AttachPolicyToRole\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ram:DetachPolicyFromRole\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Resource\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole\\\\\\\\\\\\\\"}]}\\",\\n \\"UpdateDate\\": \\"2021-03-18T08:51:33Z\\",\\n \\"Description\\": \\"ExampleControlPolicy\\",\\n \\"EffectScope\\": \\"RAM\\",\\n \\"AttachmentCount\\": \\"0\\",\\n \\"PolicyName\\": \\"test\\",\\n \\"PolicyId\\": \\"cp-SImPt8GCEwiq****\\",\\n \\"CreateDate\\": \\"2021-03-18T08:51:33Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n },\\n \\"RequestId\\": \\"AB769936-CDFA-4D52-8CE2-A3581800044A\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetControlPolicyResponse>\\r\\n\\t<ControlPolicy>\\r\\n\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t<UpdateDate>2021-03-18T08:51:33Z</UpdateDate>\\r\\n\\t\\t<Description>ExampleControlPolicy</Description>\\r\\n\\t\\t<AttachmentCount>0</AttachmentCount>\\r\\n\\t\\t<PolicyName>test</PolicyName>\\r\\n\\t\\t<PolicyDocument>{"Version":"1","Statement":[{"Effect":"Deny","Action":["ram:UpdateRole","ram:DeleteRole","ram:AttachPolicyToRole","ram:DetachPolicyFromRole"],"Resource":"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole"}]}</PolicyDocument>\\r\\n\\t\\t<CreateDate>2021-03-18T08:51:33Z</CreateDate>\\r\\n\\t\\t<PolicyId>cp-SImPt8GCEwiq****</PolicyId>\\r\\n\\t\\t<EffectScope>RAM</EffectScope>\\r\\n\\t</ControlPolicy>\\r\\n\\t<RequestId>AB769936-CDFA-4D52-8CE2-A3581800044A</RequestId>\\r\\n</GetControlPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'GetControlPolicy', + 'summary' => 'Queries the details of an access control policy.', + 'description' => 'This topic provides an example on how to call the API operation to query the details of the access control policy whose ID is `cp-SImPt8GCEwiq****`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'NewPolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the access control policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length. The name can contain letters, digits, and hyphens (-) and must start with a letter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NewControlPolicy', + ], + ], + [ + 'name' => 'NewDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new description of the access control policy.'."\n" + ."\n" + .'The description must be 1 to 1,024 characters in length. The description can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a letter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ExampleControlPolicy', + ], + ], + [ + 'name' => 'NewPolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new document of the access control policy.'."\n" + ."\n" + .'The document can be a maximum of 4,096 characters in length.'."\n" + ."\n" + .'For more information about the languages of access control policies, see [Languages of access control policies](~~179096~~).'."\n" + ."\n" + .'For more information about the examples of access control policies, see [Examples of custom access control policies](~~181474~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Version":"1","Statement":[{"Effect":"Deny","Action":["ram:UpdateRole","ram:DeleteRole","ram:AttachPolicyToRole","ram:DetachPolicyFromRole"],"Resource":"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole"}]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ControlPolicy' => [ + 'description' => 'The details of the access control policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateDate' => [ + 'description' => 'The time when the access control policy was updated.'."\n", + 'type' => 'string', + 'example' => '2021-03-18T10:04:55Z', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => 'The effective scope of the access control policy. Valid values:'."\n" + ."\n" + .'* All: The access control policy is in effect for Alibaba Cloud accounts, RAM users, and RAM roles.'."\n" + .'* RAM: The access control policy is in effect only for RAM users and RAM roles.'."\n", + 'type' => 'string', + 'example' => 'RAM', + ], + 'AttachmentCount' => [ + 'description' => 'The number of times that the access control policy is referenced.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'PolicyName' => [ + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'NewControlPolicy', + ], + 'PolicyId' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'cp-jExXAqIYkwHN****', + ], + 'CreateDate' => [ + 'description' => 'The time when the access control policy was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-18T09:24:19Z', + ], + 'PolicyType' => [ + 'description' => 'The type of the access control policy. Valid values:'."\n" + ."\n" + .'* System: system access control policy'."\n" + .'* Custom: custom access control policy'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2DFCE4C9-04A9-4C83-BB14-FE791275EC53', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.NewPolicyDocument.Length', + 'errorMessage' => 'Unable to save your policy. A policy contains a maximum of 4096 characters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ControlPolicy\\": {\\n \\"UpdateDate\\": \\"2021-03-18T10:04:55Z\\",\\n \\"Description\\": \\"ExampleControlPolicy\\",\\n \\"EffectScope\\": \\"RAM\\",\\n \\"AttachmentCount\\": \\"0\\",\\n \\"PolicyName\\": \\"NewControlPolicy\\",\\n \\"PolicyId\\": \\"cp-jExXAqIYkwHN****\\",\\n \\"CreateDate\\": \\"2021-03-18T09:24:19Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n },\\n \\"RequestId\\": \\"2DFCE4C9-04A9-4C83-BB14-FE791275EC53\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateControlPolicyResponse>\\r\\n\\t<ControlPolicy>\\r\\n\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t<UpdateDate>2021-03-18T10:04:55Z</UpdateDate>\\r\\n\\t\\t<Description>ExampleControlPolicy</Description>\\r\\n\\t\\t<AttachmentCount>0</AttachmentCount>\\r\\n\\t\\t<PolicyName>NewControlPolicy</PolicyName>\\r\\n\\t\\t<CreateDate>2021-03-18T09:24:19Z</CreateDate>\\r\\n\\t\\t<PolicyId>cp-jExXAqIYkwHN****</PolicyId>\\r\\n\\t\\t<EffectScope>RAM</EffectScope>\\r\\n\\t</ControlPolicy>\\r\\n\\t<RequestId>2DFCE4C9-04A9-4C83-BB14-FE791275EC53</RequestId>\\r\\n</UpdateControlPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'UpdateControlPolicy', + 'summary' => 'Updates a custom access control policy.', + 'description' => 'In this example, the name of the access control policy whose ID is `cp-jExXAqIYkwHN****` is changed to `NewControlPolicy`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteControlPolicy' => [ + 'summary' => 'Deletes a custom control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cp-SImPt8GCEwiq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C8541E06-B207-46BF-92C9-DC8DE4609D75', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C8541E06-B207-46BF-92C9-DC8DE4609D75\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteControlPolicyResponse>\\r\\n\\t<RequestId>C8541E06-B207-46BF-92C9-DC8DE4609D75</RequestId>\\r\\n</DeleteControlPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DeleteControlPolicy', + 'description' => 'If you want to delete a custom control policy that is attached to folders or member accounts, you must call the [DetachControlPolicy](~~208331~~) operation to detach the policy before you delete it.'."\n" + ."\n" + .'In this example, the custom control policy `cp-SImPt8GCEwiq****` is deleted.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object to which you want to attach the access control policy. Access control policies can be attached to the following objects:'."\n" + ."\n" + .'* Root folder'."\n" + .'* Subfolders of the Root folder'."\n" + .'* Members'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ZDNPiT****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '95060F1D-6990-4645-8920-A81D1BBFE992', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Target', + 'errorMessage' => 'The specified target does not exist in the resource directory.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95060F1D-6990-4645-8920-A81D1BBFE992\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<AttachControlPolicyResponse>\\r\\n\\t<RequestId>95060F1D-6990-4645-8920-A81D1BBFE992</RequestId>\\r\\n</AttachControlPolicyResponse>","errorExample":""}]', + 'title' => 'AttachControlPolicy', + 'summary' => 'Attaches an access control policy.', + 'description' => 'After you attach an access control policy, the operations performed on resources by using members are limited by the policy. Make sure that the attached policy meets your expectations. Otherwise, your business may be affected.'."\n" + ."\n" + .'By default, the system access control policy FullAliyunAccess is attached to each folder and member.'."\n" + ."\n" + .'The access control policy that is attached to a folder also applies to all its subfolders and all members in the subfolders.'."\n" + ."\n" + .'A maximum of 10 access control policies can be attached to a folder or member.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to attach the custom access control policy `cp-jExXAqIYkwHN****` to the folder `fd-ZDNPiT****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachControlPolicy' => [ + 'summary' => 'Detaches an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object from which you want to detach the access control policy. Access control policies can be attached to the following objects:'."\n" + ."\n" + .'* Root folder'."\n" + .'* Subfolders of the Root folder'."\n" + .'* Members'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ZDNPiT****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotSupport.DetachLastControlPolicy', + 'errorMessage' => 'It is not detach the last control policy on the target node.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Target', + 'errorMessage' => 'The specified target does not exist in the resource directory.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DetachControlPolicyResponse>\\r\\n\\t<RequestId>9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC</RequestId>\\r\\n</DetachControlPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DetachControlPolicy', + 'description' => 'After you detach an access control policy, the operations performed on resources by using members are not limited by the policy. Make sure that the detached policy meets your expectations. Otherwise, your business may be affected.'."\n" + ."\n" + .'Both the system and custom access control policies can be detached. If an object has only one access control policy attached, the policy cannot be detached.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to detach the custom control policy `cp-jExXAqIYkwHN****` from the folder `fd-ZDNPiT****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListControlPolicies' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the access control policy. Valid values:'."\n" + ."\n" + .'- System: system access control policy'."\n" + .'- Custom: custom access control policy', + 'type' => 'string', + 'required' => false, + 'example' => 'System', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. '."\n" + ."\n" + .'Page start from page 1. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. '."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the descriptions of the access control policies. Valid values:'."\n" + ."\n" + .'- zh-CN (default value): Chinese'."\n" + .'- en: English'."\n" + .'- ja: Japanese'."\n" + ."\n" + .'> This parameter is valid only for system access control policies.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The number of access control policies.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '9424A34C-3471-45AD-B6AB-924BBDFE42F9', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ControlPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ControlPolicy' => [ + 'description' => 'The access control policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The access control policies.', + 'type' => 'object', + 'properties' => [ + 'UpdateDate' => [ + 'description' => 'The time when the access control policy was updated.', + 'type' => 'string', + 'example' => '2020-08-05T06:32:24Z', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.', + 'type' => 'string', + 'example' => 'System access control policy available for all operations on the cloud', + ], + 'EffectScope' => [ + 'description' => 'The effective scope of the access control policy. Valid values:'."\n" + ."\n" + .'- All: The access control policy is in effect for Alibaba Cloud accounts, RAM users, and RAM roles.'."\n" + .'- RAM: The access control policy is in effect only for RAM users and RAM roles.', + 'type' => 'string', + 'example' => 'All', + ], + 'AttachmentCount' => [ + 'description' => 'The number of times that the access control policy is referenced.', + 'type' => 'string', + 'example' => '44', + ], + 'PolicyName' => [ + 'description' => 'The name of the access control policy.', + 'type' => 'string', + 'example' => 'FullAliyunAccess', + ], + 'PolicyId' => [ + 'description' => 'The ID of the access control policy.', + 'type' => 'string', + 'example' => 'cp-FullAliyunAccess', + ], + 'CreateDate' => [ + 'description' => 'The time when the access control policy was created.', + 'type' => 'string', + 'example' => '2020-08-05T06:32:24Z', + ], + 'PolicyType' => [ + 'description' => 'The type of the access control policy. Valid values:'."\n" + ."\n" + .'- System: system access control policy'."\n" + .'- Custom: custom access control policy', + 'type' => 'string', + 'example' => 'System', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"9424A34C-3471-45AD-B6AB-924BBDFE42F9\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ControlPolicies\\": {\\n \\"ControlPolicy\\": [\\n {\\n \\"UpdateDate\\": \\"2020-08-05T06:32:24Z\\",\\n \\"Description\\": \\"支持阿里云所有操作的系统管控策略\\",\\n \\"EffectScope\\": \\"All\\",\\n \\"AttachmentCount\\": \\"44\\",\\n \\"PolicyName\\": \\"FullAliyunAccess\\",\\n \\"PolicyId\\": \\"cp-FullAliyunAccess\\",\\n \\"CreateDate\\": \\"2020-08-05T06:32:24Z\\",\\n \\"PolicyType\\": \\"System\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListControlPoliciesResponse>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<RequestId>9424A34C-3471-45AD-B6AB-924BBDFE42F9</RequestId>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<ControlPolicies>\\r\\n\\t\\t<ControlPolicy>\\r\\n\\t\\t\\t<PolicyType>System</PolicyType>\\r\\n\\t\\t\\t<UpdateDate>2020-08-05T06:32:24Z</UpdateDate>\\r\\n\\t\\t\\t<Description>支持阿里云所有操作的系统管控策略</Description>\\r\\n\\t\\t\\t<AttachmentCount>44</AttachmentCount>\\r\\n\\t\\t\\t<PolicyName>FullAliyunAccess</PolicyName>\\r\\n\\t\\t\\t<CreateDate>2020-08-05T06:32:24Z</CreateDate>\\r\\n\\t\\t\\t<PolicyId>cp-FullAliyunAccess</PolicyId>\\r\\n\\t\\t\\t<EffectScope>All</EffectScope>\\r\\n\\t\\t</ControlPolicy>\\r\\n\\t</ControlPolicies>\\r\\n</ListControlPoliciesResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListControlPolicies', + 'summary' => 'Queries access control policies.', + 'description' => 'This topic provides an example on how to call the API operation to query the system access control policies within a resource directory. The response shows that the resource directory has only one system access control policy. The policy is named `FullAliyunAccess`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](/help/en/resource-management/latest/common-parameters).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListControlPolicyAttachmentsForTarget' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object whose access control policies you want to query. Access control policies can be attached to the following objects:'."\n" + ."\n" + .'* Root folder'."\n" + .'* Subfolders of the Root folder'."\n" + .'* Members'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ZDNPiT****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the descriptions of the access control policies. Valid values:'."\n" + ."\n" + .'* zh-CN (default value): Chinese'."\n" + .'* en: English'."\n" + .'* ja: Japanese'."\n" + ."\n" + .'> This parameter is valid only for system access control policies.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C276B600-7B7A-49E8-938C-E16CFA955A82', + ], + 'ControlPolicyAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ControlPolicyAttachment' => [ + 'description' => 'The attached access control policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => 'The effective scope of the access control policy. Valid values:'."\n" + ."\n" + .'* All: The access control policy is in effect for Alibaba Cloud accounts, RAM users, and RAM roles.'."\n" + .'* RAM: The access control policy is in effect only for RAM users and RAM roles.'."\n", + 'type' => 'string', + 'example' => 'RAM', + ], + 'PolicyName' => [ + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'PolicyId' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'cp-jExXAqIYkwHN****', + ], + 'AttachDate' => [ + 'description' => 'The time when the access control policy was attached.'."\n", + 'type' => 'string', + 'example' => '2021-03-19T02:56:24Z', + ], + 'PolicyType' => [ + 'description' => 'The type of the access control policy. Valid values:'."\n" + ."\n" + .'* System: system access control policy'."\n" + .'* Custom: custom access control policy'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Target', + 'errorMessage' => 'The specified target does not exist in the resource directory.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C276B600-7B7A-49E8-938C-E16CFA955A82\\",\\n \\"ControlPolicyAttachments\\": {\\n \\"ControlPolicyAttachment\\": [\\n {\\n \\"Description\\": \\"ExampleControlPolicy\\",\\n \\"EffectScope\\": \\"RAM\\",\\n \\"PolicyName\\": \\"ExampleControlPolicy\\",\\n \\"PolicyId\\": \\"cp-jExXAqIYkwHN****\\",\\n \\"AttachDate\\": \\"2021-03-19T02:56:24Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListControlPolicyAttachmentsForTargetResponse>\\r\\n\\t<RequestId>C276B600-7B7A-49E8-938C-E16CFA955A82</RequestId>\\r\\n\\t<ControlPolicyAttachments>\\r\\n\\t\\t<ControlPolicyAttachment>\\r\\n\\t\\t\\t<PolicyType>System</PolicyType>\\r\\n\\t\\t\\t<Description>支持阿里云所有操作的系统管控策略</Description>\\r\\n\\t\\t\\t<AttachDate>2021-03-18T07:27:59Z</AttachDate>\\r\\n\\t\\t\\t<PolicyName>FullAliyunAccess</PolicyName>\\r\\n\\t\\t\\t<PolicyId>cp-FullAliyunAccess</PolicyId>\\r\\n\\t\\t</ControlPolicyAttachment>\\r\\n\\t\\t<ControlPolicyAttachment>\\r\\n\\t\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t\\t<Description>ExampleControlPolicy</Description>\\r\\n\\t\\t\\t<AttachDate>2021-03-19T02:56:24Z</AttachDate>\\r\\n\\t\\t\\t<PolicyName>ExampleControlPolicy</PolicyName>\\r\\n\\t\\t\\t<PolicyId>cp-jExXAqIYkwHN****</PolicyId>\\r\\n\\t\\t</ControlPolicyAttachment>\\r\\n\\t</ControlPolicyAttachments>\\r\\n</ListControlPolicyAttachmentsForTargetResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListControlPolicyAttachmentsForTarget', + 'summary' => 'Queries the access control policies that are attached to a folder or member.', + 'description' => 'This topic provides an example on how to call the API operation to query the access control policies that are attached to the folder `fd-ZDNPiT****`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTargetAttachmentsForControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of objects to which the control policy is attached.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B32BD3D6-1089-41F3-8E70-E0079BC7D760', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TargetAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetAttachment' => [ + 'description' => 'The list of objects to which the control policy is attached.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => 'The ID of the object.'."\n", + 'type' => 'string', + 'example' => 'fd-ZDNPiT****', + ], + 'TargetName' => [ + 'description' => 'The name of the object.'."\n", + 'type' => 'string', + 'example' => 'Dev_Department', + ], + 'AttachDate' => [ + 'description' => 'The time when the control policy was attached to the object.'."\n", + 'type' => 'string', + 'example' => '2021-03-19T02:56:24Z', + ], + 'TargetType' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* Root: Root folder'."\n" + .'* Folder: child folder of the Root folder'."\n" + .'* Account: member account'."\n", + 'type' => 'string', + 'example' => 'Folder', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"B32BD3D6-1089-41F3-8E70-E0079BC7D760\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TargetAttachments\\": {\\n \\"TargetAttachment\\": [\\n {\\n \\"TargetId\\": \\"fd-ZDNPiT****\\",\\n \\"TargetName\\": \\"Dev_Department\\",\\n \\"AttachDate\\": \\"2021-03-19T02:56:24Z\\",\\n \\"TargetType\\": \\"Folder\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListTargetAttachmentsForControlPolicyResponse>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<RequestId>B32BD3D6-1089-41F3-8E70-E0079BC7D760</RequestId>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<TargetAttachments>\\r\\n\\t\\t<TargetAttachment>\\r\\n\\t\\t\\t<AttachDate>2021-03-19T02:56:24Z</AttachDate>\\r\\n\\t\\t\\t<TargetType>Folder</TargetType>\\r\\n\\t\\t\\t<TargetName>Dev_Department</TargetName>\\r\\n\\t\\t\\t<TargetId>fd-ZDNPiT****</TargetId>\\r\\n\\t\\t</TargetAttachment>\\r\\n\\t</TargetAttachments>\\r\\n</ListTargetAttachmentsForControlPolicyResponse>\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => 'ListTargetAttachmentsForControlPolicy', + 'summary' => 'Queries the objects to which a specific control policy is attached.', + 'description' => 'In this example, the folders or member accounts to which the control policy `cp-jExXAqIYkwHN****` is attached are queried. The returned result shows that the control policy is attached to the folder `fd-ZDNPiT****`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTrustedServiceStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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' => 'AdminAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the enterprise management account or delegated administrator account.'."\n" + ."\n" + .'* If you set this parameter to the ID of an enterprise management account, the trusted services that are enabled within the enterprise management account are queried. The default value of this parameter is the ID of an enterprise management account.'."\n" + .'* If you set this parameter to the ID of a delegated administrator account, the trusted services that are enabled within the delegated administrator account are queried.'."\n" + ."\n" + .'For more information about trusted services and delegated administrator accounts, see [Overview of trusted services](~~208133~~) and [Delegated administrator accounts](~~208117~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '177242285274****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CD76D376-2517-4924-92C5-DBC52262F93A', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnabledServicePrincipals' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EnabledServicePrincipal' => [ + 'description' => 'The trusted services that are enabled.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServicePrincipal' => [ + 'description' => 'The identification of the trusted service.'."\n", + 'type' => 'string', + 'example' => 'config.aliyuncs.com', + ], + 'EnableTime' => [ + 'description' => 'The time when the trusted service was enabled.'."\n", + 'type' => 'string', + 'example' => '2019-02-18T15:32:10.473Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"CD76D376-2517-4924-92C5-DBC52262F93A\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"EnabledServicePrincipals\\": {\\n \\"EnabledServicePrincipal\\": [\\n {\\n \\"ServicePrincipal\\": \\"config.aliyuncs.com\\",\\n \\"EnableTime\\": \\"2019-02-18T15:32:10.473Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListTrustedServiceStatusResponse>\\r\\n <EnabledServicePrincipal>\\r\\n <ServicePrincipal>config.aliyuncs.com</ServicePrincipal>\\r\\n <EnableTime>2019-02-18T15:32:10.473Z</EnableTime>\\r\\n </EnabledServicePrincipal>\\r\\n <EnabledServicePrincipal>\\r\\n <ServicePrincipal>actiontrail.aliyuncs.com</ServicePrincipal>\\r\\n <EnableTime>2019-02-16T15:32:10.473Z</EnableTime>\\r\\n </EnabledServicePrincipal>\\r\\n <RequestId>CD76D376-2517-4924-92C5-DBC52262F93A</RequestId>\\r\\n</ListTrustedServiceStatusResponse>","errorExample":""}]', + 'title' => 'ListTrustedServiceStatus', + 'summary' => 'Queries the trusted services that are enabled within an enterprise management account or delegated administrator account.', + 'description' => '> Only an enterprise management account or delegated administrator account can be used to call this operation.'."\n" + ."\n" + .'In this example, the trusted services that are enabled within an enterprise management account are queried. The returned result shows that the trusted services Cloud Config and ActionTrail are enabled within the enterprise management account.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RegisterDelegatedAdministrator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member in the resource directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'ServicePrincipal', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the trusted service.'."\n" + ."\n" + .'For more information, see the `Trusted service identifier` column in [Supported trusted services](~~208133~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cloudfw.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0A45FC8F-54D2-4A65-8338-25E5DEBDA304', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'InvalidParameter.ServicePrincipal', + 'errorMessage' => 'The specified ServicePrincipal is invalid.', + ], + [ + 'errorCode' => 'AccountAlreadyRegistered', + 'errorMessage' => 'The specified account is already a delegated administrator for this service.', + ], + [ + 'errorCode' => 'DelegatedAccountNumberExceeded', + 'errorMessage' => 'The maximum number of delegated administrators for the service principal is exceeded.', + ], + [ + 'errorCode' => 'CannotRegisterMasterAsDelegatedAdministrator', + 'errorMessage' => 'You attempted to register the enterprise management account as a delegated administrator for the service. You can designate only a member account as a delegated administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0A45FC8F-54D2-4A65-8338-25E5DEBDA304\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<RegisterDelegatedAdministratorResponse>\\r\\n\\t<RequestId>0A45FC8F-54D2-4A65-8338-25E5DEBDA304</RequestId>\\r\\n</RegisterDelegatedAdministratorResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'RegisterDelegatedAdministrator', + 'summary' => 'Specifies a member in a resource directory as a delegated administrator account of a trusted service.', + 'description' => 'The delegated administrator account can be used to access the information of the resource directory and view the structure and members of the resource directory. The delegated administrator account can also be used to perform service-related management operations in the trusted service on behalf of the management account of the resource directory.'."\n" + ."\n" + .'When you call this operation, you must take note of the following limits:'."\n" + ."\n" + .'* Only some trusted services support delegated administrator accounts. For more information, see [Supported trusted services](~~208133~~).'."\n" + .'* Only the management account of a resource directory or an authorized RAM user or RAM role of the management account can be used to call this operation.'."\n" + .'* The number of delegated administrator accounts that are allowed for a trusted service is defined by the trusted service.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to specify the member `181761095690****` as a delegated administrator account of Cloud Firewall.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeregisterDelegatedAdministrator' => [ + 'summary' => 'Removes a delegated administrator account for a trusted service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member in the resource directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'ServicePrincipal', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the trusted service.'."\n" + ."\n" + .'For more information, see the `Trusted service identifier` column in [Supported trusted services](~~208133~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cloudfw.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DF5D5C52-7BD0-40E7-94C6-23A1505038A2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'InvalidParameter.ServicePrincipal', + 'errorMessage' => 'The specified ServicePrincipal is invalid.', + ], + [ + 'errorCode' => 'AccountNotRegistered', + 'errorMessage' => 'The specified account is not a delegated administrator for this service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DF5D5C52-7BD0-40E7-94C6-23A1505038A2\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeregisterDelegatedAdministratorResponse>\\r\\n\\t<RequestId>DF5D5C52-7BD0-40E7-94C6-23A1505038A2</RequestId>\\r\\n</DeregisterDelegatedAdministratorResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DeregisterDelegatedAdministrator', + 'description' => '> If the delegated administrator account that you want to remove has historical management tasks in the related trusted service, the trusted service may be affected after the delegated administrator account is removed. Therefore, proceed with caution.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to remove the delegated administrator account `181761095690****` for Cloud Firewall.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDelegatedAdministrators' => [ + 'summary' => 'Queries delegated administrator accounts.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ServicePrincipal', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the trusted service.'."\n" + ."\n" + .'For more information, see the `Trusted service identifier` column in [Supported trusted services](~~208133~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloudfw.aliyuncs.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '009C3A02-7D4B-416C-9CE7-548C91508F1E', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the delegated administrator accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'string', + 'example' => '138660628348****', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member joins the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member is invited to join the resource directory.'."\n" + .'* created: The member is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ServicePrincipal' => [ + 'description' => 'The identifier of the trusted service.'."\n", + 'type' => 'string', + 'example' => 'cloudfw.aliyuncs.com', + ], + 'DelegationEnabledTime' => [ + 'description' => 'The time when the member was specified as a delegated administrator account.'."\n", + 'type' => 'string', + 'example' => '1616652684164', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"009C3A02-7D4B-416C-9CE7-548C91508F1E\\",\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"AccountId\\": \\"138660628348****\\",\\n \\"DisplayName\\": \\"abc\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ServicePrincipal\\": \\"cloudfw.aliyuncs.com\\",\\n \\"DelegationEnabledTime\\": \\"1616652684164\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListDelegatedAdministratorsResponse>\\r\\n\\t<RequestId>009C3A02-7D4B-416C-9CE7-548C91508F1E</RequestId>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Accounts>\\r\\n\\t\\t<Account>\\r\\n\\t\\t\\t<DelegationEnabledTime>1616652684164</DelegationEnabledTime>\\r\\n\\t\\t\\t<JoinMethod>created</JoinMethod>\\r\\n\\t\\t\\t<AccountId>138660628348****</AccountId>\\r\\n\\t\\t\\t<ServicePrincipal>cloudfw.aliyuncs.com</ServicePrincipal>\\r\\n\\t\\t\\t<DisplayName>abc</DisplayName>\\r\\n\\t\\t</Account>\\r\\n\\t\\t<Account>\\r\\n\\t\\t\\t<DelegationEnabledTime>1616489836069</DelegationEnabledTime>\\r\\n\\t\\t\\t<JoinMethod>invited</JoinMethod>\\r\\n\\t\\t\\t<AccountId>177242285274****</AccountId>\\r\\n\\t\\t\\t<ServicePrincipal>cloudfw.aliyuncs.com</ServicePrincipal>\\r\\n\\t\\t\\t<DisplayName>test</DisplayName>\\r\\n\\t\\t</Account>\\r\\n\\t</Accounts>\\r\\n</ListDelegatedAdministratorsResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListDelegatedAdministrators', + 'description' => 'This topic provides an example on how to call the API operation to query all delegated administrator accounts in a resource directory. The response shows that two delegated administrator accounts for Cloud Firewall exist in the resource directory.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDelegatedServicesForAccount' => [ + 'summary' => 'Queries the trusted services for which a member is specified as a delegated administrator account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '138660628348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D9C03B94-9396-4794-A74B-13DC437556A6', + ], + 'DelegatedServices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DelegatedService' => [ + 'description' => 'The trusted services.'."\n" + ."\n" + .'> If the value of this parameter is empty, the member is not specified as a delegated administrator account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DelegationEnabledTime' => [ + 'description' => 'The time when the member was specified as a delegated administrator account of the trusted service.'."\n", + 'type' => 'string', + 'example' => '1616652684164', + ], + 'ServicePrincipal' => [ + 'description' => 'The identification of the trusted service.'."\n", + 'type' => 'string', + 'example' => 'cloudfw.aliyuncs.com', + ], + 'Status' => [ + 'description' => 'The status of the trusted service. Valid values:'."\n" + ."\n" + .'* ENABLED: enabled'."\n" + .'* DISABLED: disabled'."\n", + 'type' => 'string', + 'example' => 'ENABLED', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9C03B94-9396-4794-A74B-13DC437556A6\\",\\n \\"DelegatedServices\\": {\\n \\"DelegatedService\\": [\\n {\\n \\"DelegationEnabledTime\\": \\"1616652684164\\",\\n \\"ServicePrincipal\\": \\"cloudfw.aliyuncs.com\\",\\n \\"Status\\": \\"ENABLED\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDelegatedServicesForAccountResponse>\\n <RequestId>D9C03B94-9396-4794-A74B-13DC437556A6</RequestId>\\n <DelegatedServices>\\n <DelegatedService>\\n <Status>ENABLED</Status>\\n <DelegationEnabledTime>1616652684164</DelegationEnabledTime>\\n <ServicePrincipal>cloudfw.aliyuncs.com</ServicePrincipal>\\n </DelegatedService>\\n </DelegatedServices>\\n</ListDelegatedServicesForAccountResponse>","errorExample":""}]', + 'title' => 'ListDelegatedServicesForAccount', + 'description' => 'This topic provides an example on how to call the API operation to query the trusted services for which the member `138660628348****` is specified as a delegated administrator account. The response shows that the member is specified as a delegated administrator account of Cloud Firewall.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateResourceGroup' => [ + 'summary' => 'Creates a resource group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the resource group.'."\n" + ."\n" + .'It must be 2 to 50 characters in length and can contain letters, digits, and hyphens (-). It must start with a letter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the resource group.'."\n" + ."\n" + .'It must be 1 to 50 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n" + ."\n" + .'The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ResourceGroup' => [ + 'description' => 'The information of the resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource group belongs.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'CreateDate' => [ + 'description' => 'The time when the resource group was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-06-05T14:39:13+08:00', + ], + 'DisplayName' => [ + 'description' => 'The display name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => 'The unique identifier of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'RegionStatuses' => [ + 'description' => 'The status of the resource group in all regions.'."\n", + 'type' => 'object', + 'items' => [ + 'description' => 'The status of the resource group in all regions.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'name' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'cn-qingdao', + 'backendName' => 'regionId', + ], + 'Status' => [ + 'name' => 'Status', + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Creating', + 'backendName' => 'status', + ], + ], + 'extendType' => 'true', + ], + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n", + 'type' => 'string', + 'example' => 'Creating', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Name.InvalidChars', + 'errorMessage' => 'The Name is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Name.Length', + 'errorMessage' => 'The maximum length of Name is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.DisplayName.Length', + 'errorMessage' => 'The maximum length of DisplayName is exceeded.', + ], + [ + 'errorCode' => 'MissingParameter.DisplayName', + 'errorMessage' => 'You must specify DisplayName.', + ], + [ + 'errorCode' => 'InvalidParameter.DisplayName', + 'errorMessage' => 'The DisplayName is invalid.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.ResourceGroup', + 'errorMessage' => 'The count of resource groups beyond the current limits.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ResourceGroup\\": {\\n \\"AccountId\\": \\"151266687691****\\",\\n \\"CreateDate\\": \\"2021-06-05T14:39:13+08:00\\",\\n \\"DisplayName\\": \\"my-project\\",\\n \\"Id\\": \\"rg-9gLOoK****\\",\\n \\"Name\\": \\"my-project\\",\\n \\"RegionStatuses\\": {\\n \\"RegionStatus\\": [\\n {\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"Creating\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateResourceGroupResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n\\t<ResourceGroup>\\r\\n\\t\\t<Status>Creating</Status>\\r\\n\\t\\t<RegionStatuses>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>ap-northeast-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>ap-south-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>ap-southeast-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>ap-southeast-2</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>ap-southeast-3</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>ap-southeast-5</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-beijing</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-chengdu</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-guangzhou</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou-cloudstone</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou-test-306</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-heyuan</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-hongkong</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-huhehaote</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-north-2-gov-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-qingdao</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-shanghai</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-shanghai-finance-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-shenzhen</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-shenzhen-finance-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-wulanchabu</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>cn-zhangjiakou</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>eu-central-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>eu-west-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>me-east-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>rus-west-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>us-east-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<Status>Creating</Status>\\r\\n\\t\\t\\t\\t<RegionId>us-west-1</RegionId>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t</RegionStatuses>\\r\\n\\t\\t<AccountId>151266687691****</AccountId>\\r\\n\\t\\t<DisplayName>my-project</DisplayName>\\r\\n\\t\\t<Id>rg-9gLOoK****</Id>\\r\\n\\t\\t<CreateDate>2021-06-05T14:39:13+08:00</CreateDate>\\r\\n\\t\\t<Name>my-project</Name>\\r\\n\\t</ResourceGroup>\\r\\n</CreateResourceGroupResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => 'CreateResourceGroup', + 'description' => '> A maximum of 30 resource groups can be created within an Alibaba Cloud account.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~158855~~) operation to obtain the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01', + ], + 'ResourceGroup' => [ + 'description' => 'The information of the resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n", + 'type' => 'string', + 'example' => 'PendingDelete', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'description' => 'The status of the resource group in all regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n" + .'* Deleting: The resource group is being deleted.'."\n", + 'type' => 'string', + 'example' => 'PendingDelete', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + ], + ], + ], + ], + ], + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource group belongs.', + 'type' => 'string', + 'example' => '123456789****', + ], + 'Name' => [ + 'description' => 'The unique identifier of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'CreateDate' => [ + 'description' => 'The time when the resource group was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Id' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DeleteConflict.ResourceGroup.Resource', + 'errorMessage' => 'Failed to delete the resource group because one or more cloud resources exist in the resource group. Try again later after you release the cloud resources.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\",\\n \\"ResourceGroup\\": {\\n \\"DisplayName\\": \\"my-project\\",\\n \\"Status\\": \\"PendingDelete\\",\\n \\"RegionStatuses\\": {\\n \\"RegionStatus\\": [\\n {\\n \\"Status\\": \\"PendingDelete\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n },\\n \\"AccountId\\": \\"123456789****\\",\\n \\"Name\\": \\"my-project\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Id\\": \\"rg-9gLOoK****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteResourceGroupResponse>\\r\\n\\t<RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>\\r\\n\\t<ResourceGroup>\\r\\n\\t\\t<Id>rg-9gLOoK****</Id>\\r\\n\\t\\t<AccountId>123456789****</AccountId>\\r\\n\\t\\t<Name>my-project</Name>\\r\\n\\t\\t<DisplayName>my-project</DisplayName>\\r\\n\\t\\t<Status>PendingDelete</Status>\\r\\n\\t\\t<RegionStatuses>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t\\t<Status>PendingDelete</Status>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t\\t<RegionStatus>\\r\\n\\t\\t\\t\\t<RegionId>cn-qingdao</RegionId>\\r\\n\\t\\t\\t\\t<Status>PendingDelete</Status>\\r\\n\\t\\t\\t</RegionStatus>\\r\\n\\t\\t</RegionStatuses>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t</ResourceGroup>\\r\\n</DeleteResourceGroupResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DeleteResourceGroup', + 'summary' => 'Deletes a resource group.', + 'description' => '> Before you delete a resource group, you must delete all the resources in it.'."\n" + ."\n" + .'In this example, the resource group whose ID is `rg-9gLOoK****` is deleted.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~158855~~) operation to obtain the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'NewDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the resource group.'."\n" + ."\n" + .'The name must be 1 to 50 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ResourceGroup' => [ + 'description' => 'The information of the resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'project', + ], + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource group belongs.'."\n", + 'type' => 'string', + 'example' => '123456789****', + ], + 'Name' => [ + 'description' => 'The unique identifier of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'CreateDate' => [ + 'description' => 'The time when the resource group was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18+08:00', + ], + 'Id' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.DisplayName', + 'errorMessage' => 'The DisplayName is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.DisplayName', + 'errorMessage' => 'You must specify DisplayName.', + ], + [ + 'errorCode' => 'InvalidParameter.DisplayName.Length', + 'errorMessage' => 'The maximum length of DisplayName is exceeded.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ResourceGroup\\": {\\n \\"DisplayName\\": \\"project\\",\\n \\"AccountId\\": \\"123456789****\\",\\n \\"Name\\": \\"my-project\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18+08:00\\",\\n \\"Id\\": \\"rg-9gLOoK****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateResourceGroupResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n\\t<ResourceGroup>\\r\\n\\t\\t<Id>rg-9gLOoK****</Id>\\r\\n\\t\\t<AccountId>123456789****</AccountId>\\r\\n\\t\\t<Name>my-project</Name>\\r\\n\\t\\t<DisplayName>project</DisplayName>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18+08:00</CreateDate>\\r\\n\\t</ResourceGroup>\\r\\n</UpdateResourceGroupResponse>","errorExample":""}]', + 'title' => 'UpdateResourceGroup', + 'summary' => 'Updates the basic information of a resource group.', + 'description' => 'In this example, the display name of the resource group `rg-9gLOoK****` is changed to `project`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResourceGroups' => [ + 'summary' => 'Queries resource groups.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the resource group. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'The ID can be a maximum of 18 characters in length and must start with `rg-`.'."\n" + ."\n" + .'> This parameter is incorporated into the `ResourceGroupIds` parameter. If you configure both the `ResourceGroupId` and `ResourceGroupIds` parameters, the value of the `ResourceGroupIds` parameter prevails.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The display name of the resource group. This parameter specifies a filter condition for the query. Fuzzy match is supported.'."\n" + ."\n" + .'The display name can be a maximum of 50 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the resource group. This parameter specifies a filter condition for the query. Fuzzy match is supported.'."\n" + ."\n" + .'The identifier can be a maximum of 50 characters in length and can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tag. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags. Valid values:'."\n" + ."\n" + .'* false (default value)'."\n" + .'* true'."\n" + ."\n" + .'> If you configure the Tag parameter, the system returns the information of tags regardless of the setting of the `IncludeTags` parameter.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The IDs of the resource groups. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'You can specify a maximum of 100 resource group IDs.'."\n" + ."\n" + .'> If you configure both the `ResourceGroupId` and `ResourceGroupIds` parameters, the value of the `ResourceGroupIds` parameter prevails.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"rg-1hSBH2****","rg-9gLOoK****"}', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E', + ], + 'ResourceGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourceGroup' => [ + 'description' => 'The information of the resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource group belongs.'."\n", + 'type' => 'string', + 'example' => '123456789****', + ], + 'CreateDate' => [ + 'description' => 'The time when the resource group was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DisplayName' => [ + 'description' => 'The display name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => 'The identifier of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are added to the resource group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"ResourceGroups\\": {\\n \\"ResourceGroup\\": [\\n {\\n \\"AccountId\\": \\"123456789****\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"DisplayName\\": \\"my-project\\",\\n \\"Id\\": \\"rg-9gLOoK****\\",\\n \\"Name\\": \\"my-project\\",\\n \\"Status\\": \\"OK\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"k1\\",\\n \\"TagValue\\": \\"v1\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<ListResourceGroupsResponse>\\n <RequestId>4B450CA1-36E8-4AA2-8461-86B42BF4CC4E</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>2</TotalCount>\\n <ResourceGroups>\\n <ResourceGroup>\\n <Id>rg-1hSBH2****</Id>\\n <AccountId>123456789****</AccountId>\\n <Name>default</Name>\\n <DisplayName>默认资源组</DisplayName>\\n <Status>OK</Status>\\n <CreateDate>2015-01-23T12:33:18Z</CreateDate>\\n <Tags>\\n <Tag>\\n <TagKey>k1</TagKey>\\n <TagValue>v1</TagValue>\\n </Tag>\\n </Tags>\\n </ResourceGroup>\\n <ResourceGroup>\\n <Id>rg-9gLOoK****</Id>\\n <AccountId>123456789****</AccountId>\\n <Name>my-project</Name>\\n <DisplayName>my-project</DisplayName>\\n <Status>OK</Status>\\n <CreateDate>2015-01-23T12:33:18Z</CreateDate>\\n <Tags>\\n <Tag>\\n <TagKey>k2</TagKey>\\n <TagValue>v2</TagValue>\\n </Tag>\\n </Tags>\\n </ResourceGroup>\\n </ResourceGroups>\\n</ListResourceGroupsResponse>","errorExample":""}]', + 'title' => 'ListResourceGroups', + 'description' => 'You can call this API operation to query all resource groups within the current account. You can also call this API operation to query a specific resource group based on the status, ID, identifier, or display name of the resource group.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the basic information about the resource groups `rg-1hSBH2****` and `rg-9gLOoK****` within the current account.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResources' => [ + 'summary' => 'Queries resources that can be accessed by the current account in resource groups.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-uPJpP****', + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n" + ."\n" + .'You can obtain the ID from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'For more information about the supported resource types, see the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-23v38****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource types. A maximum of 50 resource types are supported.'."\n" + ."\n" + .'> If you configure `ResourceTypes`, you must configure both `Service` and `ResourceType`. Otherwise, the configured Service or ResourceType does not take effect.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource types.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about the supported resource types, see the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n" + ."\n" + .'> You must configure both `Service` and `ResourceType` in `ResourceTypes`. Otherwise, the two parameters do not take effect.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'You can obtain the ID from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n" + ."\n" + .'> You must configure both `Service` and `ResourceType` in `ResourceTypes`. Otherwise, the two parameters do not take effect.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The information about the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resources.', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the resource was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-uPJpP****', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'i-23v38****', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceIds', + 'errorMessage' => 'The ResourceIds is invalid.', + ], + [ + 'errorCode' => 'LimitExceeded.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceId is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-uPJpP****\\",\\n \\"ResourceId\\": \\"i-23v38****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Service\\": \\"ecs\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListResourcesResponse>\\r\\n\\t<RequesgtId>04F0F334-1335-436C-A1D7-6C044FE73368</RequesgtId>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<Resources>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<ResourceGroupId>rg-uPJpP****</ResourceGroupId>\\r\\n\\t\\t\\t<Service>ecs</Service>\\r\\n\\t\\t\\t<ResourceType>instance</ResourceType>\\r\\n\\t\\t\\t<ResourceId>i-23v38****</ResourceId>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resources>\\r\\n</ListResourcesResponse>\\t","errorExample":""}]', + 'title' => 'ListResources', + 'description' => '> You can use a RAM role that is not associated with a session policy to call this API operation.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query resources that can be accessed by the current account in resource groups. The response shows that the current account can access only the Elastic Compute Service (ECS) instance `i-23v38****` in the resource group `rg-uPJpP****`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetResourceGroup' => [ + 'summary' => 'Queries the information of a resource group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~158855~~) operation to obtain the ID of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags. Valid values:'."\n" + ."\n" + .'* false (default value)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + 'ResourceGroup' => [ + 'description' => 'The information of the resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource group belongs.', + 'type' => 'string', + 'example' => '123456789****', + ], + 'CreateDate' => [ + 'description' => 'The time when the resource group was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DisplayName' => [ + 'description' => 'The display name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => 'The identifier of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'description' => 'The status of the resource group in all regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n" + .'* Deleting: The resource group is being deleted.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are added to the resource group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are added to the resource group.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + [ + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\",\\n \\"ResourceGroup\\": {\\n \\"AccountId\\": \\"123456789****\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"DisplayName\\": \\"my-project\\",\\n \\"Id\\": \\"rg-9gLOoK****\\",\\n \\"Name\\": \\"my-project\\",\\n \\"RegionStatuses\\": {\\n \\"RegionStatus\\": [\\n {\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"Status\\": \\"OK\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"OK\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"k1\\",\\n \\"TagValue\\": \\"v1\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResourceGroupResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF5189484043</RequestId>\\n <ResourceGroup>\\n <Id>rg-9gLOoK****</Id>\\n <AccountId>123456789****</AccountId>\\n <Name>my-project</Name>\\n <DisplayName>my-project</DisplayName>\\n <Status>OK</Status>\\n <RegionStatuses>\\n <RegionStatus>\\n <RegionId>cn-hangzhou</RegionId>\\n <Status>OK</Status>\\n </RegionStatus>\\n <RegionStatus>\\n <RegionId>cn-qingdao</RegionId>\\n <Status>OK</Status>\\n </RegionStatus>\\n </RegionStatuses>\\n <CreateDate>2015-01-23T12:33:18Z</CreateDate>\\n <Tags>\\n <Tag>\\n <TagKey>k1</TagKey>\\n <TagValue>v1</TagValue>\\n </Tag>\\n </Tags>\\n </ResourceGroup>\\n</GetResourceGroupResponse>","errorExample":""}]', + 'title' => 'GetResourceGroup', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MoveResources' => [ + 'summary' => 'Moves resources from one resource group to another. You can move multiple resources that reside in different regions, are used by different Alibaba Cloud services, or belong to different resource groups.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which you want to move the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekzmeobk5w****', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resources that you want to move.'."\n" + ."\n" + .'> You can move a maximum of 10 resources at a time. If you want to move more than 10 resources, move them in batches.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resources that you want to move.'."\n" + ."\n" + .'> You can move a maximum of 10 resources at a time. If you want to move more than 10 resources, move them in batches.', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1sig0mjktx5ewx1****', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + 'Service' => [ + 'description' => 'The ID of the Alibaba Cloud service to which the resource belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C00B89D3-3247-11DE-95D8-A7C01FB0AB4F', + ], + 'Responses' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Responses', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'> This parameter is returned if the resource failed to be moved.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'ErrorMsg' => [ + 'description' => 'The error message returned.'."\n" + ."\n" + .'> This parameter is returned if the resource failed to be moved.'."\n", + 'type' => 'string', + 'example' => 'No permissions', + ], + 'RegionId' => [ + 'description' => 'The region ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C00B89D3-3247-11DE-95D8-A7C01FB0AB4F', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1sig0mjktx5ewx1****', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'Service' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'Status' => [ + 'description' => 'The status of the move task. Valid values:'."\n" + ."\n" + .'* SUCCESS'."\n" + .'* FAIL'."\n", + 'type' => 'string', + 'example' => 'FAIL', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SERVICE_REGION_NO_ENDPOINT', + 'errorMessage' => 'Please input right service and region', + ], + [ + 'errorCode' => 'EntityExists.AssociatedTransferTask', + 'errorMessage' => 'An associated transfer task is in progress. Try again later.', + ], + [ + 'errorCode' => 'NotAllowMove.ExistsAssociatedTransferRule', + 'errorMessage' => 'Associated resources cannot be transferred while the primary resource is being transferred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C00B89D3-3247-11DE-95D8-A7C01FB0AB4F\\",\\n \\"Responses\\": [\\n {\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"ErrorMsg\\": \\"没权限\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"C00B89D3-3247-11DE-95D8-A7C01FB0AB4F\\",\\n \\"ResourceId\\": \\"i-23v38****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Service\\": \\"ecs\\",\\n \\"Status\\": \\"FAIL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<MoveResourcesResponse>\\n <RequestId>C00B89D3-3247-11DE-95D8-A7C01FB0AB4F</RequestId>\\n <Responses>\\n <Service>ecs</Service>\\n <ResourceId>i-23v38****</ResourceId>\\n <ResourceType>instance</ResourceType>\\n <RequestId>C00B89D3-3247-11DE-95D8-A7C01FB0AB4F</RequestId>\\n <Status>SUCCESS</Status>\\n <ErrorCode/>\\n <ErrorMsg/>\\n <RegionId>cn-hangzhou</RegionId>\\n </Responses>\\n</MoveResourcesResponse>","errorExample":""}]', + 'title' => 'MoveResources', + 'description' => 'For more information about Alibaba Cloud services whose resources can be moved between resource groups, see the **Supported by the API** column in [Alibaba Cloud services that support resource groups](~~94479~~).'."\n" + ."\n" + .'In this example, two virtual private clouds (VPCs) `vpc-bp1sig0mjktx5ewx1****` and `vpc-bp1visxm225pv49dz****` that reside in different regions and belong to different resource groups are moved to the resource group `rg-aekzmeobk5w****`.'."\n", + 'requestParamsDescription' => '> '."\n" + ."\n" + .'* You can call the [ListResources](~~159993~~) operation to obtain the values of the `Service`, `RegionId`, `ResourceId`, `ResourceGroupId`, and `ResourceType` request parameters.'."\n" + .'* For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'EnableAutoGrouping' => [ + 'summary' => 'Enables the Automatic Resource Transfer feature. After the feature is enabled, you can create, update, delete, and query transfer rules.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DF5D5C52-7BD0-40E7-94C6-23A1505038A2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'UnsupportedOperation.RepeatEnableAutoGrouping', + 'errorMessage' => 'The auto grouping is already enabled. Please do not repeat the operation.', + ], + [ + 'errorCode' => 'Conflict.ServiceStatus', + 'errorMessage' => 'The service status conflict occurred due to frequent service enabled and disabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF5D5C52-7BD0-40E7-94C6-23A1505038A2\\"\\n}","type":"json"}]', + 'title' => 'EnableAutoGrouping', + ], + 'DisableAutoGrouping' => [ + 'summary' => 'Disables the Automatic Resource Transfer feature. After the feature is disabled, existing custom transfer rules and existing transfer rules for associated resources are deleted. However, existing relationships between resources and resource groups are not affected. If you still want to use this feature, you can enable it again 1 minute later.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '898FAB24-7509-43EE-A287-086FE4C44394', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'UnsupportedOperation.RepeatDisableAutoGrouping', + 'errorMessage' => 'The auto grouping is already disabled. Please do not repeat the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}","type":"json"}]', + 'title' => 'DisableAutoGrouping', + ], + 'UpdateAutoGroupingConfig' => [ + 'summary' => 'Updates the configuration of the Automatic Resource Transfer feature. You can update only the configuration of the Transfer Existing Associated Resources feature.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EnableExistingResourcesTransfer', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the Transfer Existing Associated Resources feature. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2CBCA30-C8DD-423E-B4AD-4FB694C9180C\\"\\n}","type":"json"}]', + 'title' => 'UpdateAutoGroupingConfig', + ], + 'GetAutoGroupingStatus' => [ + 'summary' => 'Queries the status of the Automatic Resource Transfer feature.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableExistedResourcesTransfer' => [ + 'description' => 'Indicates whether the Transfer Existing Associated Resources feature is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableStatus' => [ + 'description' => 'The status of the Automatic Resource Transfer feature. Valid values:'."\n" + ."\n" + .'* Enabling: The feature is being enabled.'."\n" + .'* Enable: The feature is enabled.'."\n" + .'* Partial_Enable: The transfer of associated resources is enabled, but custom transfer rule-based resource transfer is disabled. You can call the [EnableAutoGrouping](~~2870380~~) operation to enable custom transfer rule-based resource transfer.'."\n" + .'* Disable: The feature is disabled.', + 'type' => 'string', + 'example' => 'Enable', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0217AFEB-5318-56D4-B167-1933D83EDF3F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EnableExistedResourcesTransfer\\": true,\\n \\"EnableStatus\\": \\"Enable\\",\\n \\"RequestId\\": \\"0217AFEB-5318-56D4-B167-1933D83EDF3F\\"\\n}","type":"json"}]', + 'title' => 'GetAutoGroupingStatus', + ], + 'CreateAutoGroupingRule' => [ + 'summary' => 'Creates a transfer rule. Custom transfer rules and transfer rules for associated resources are supported.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Custom Transfer Rule for Online Resources of Project A', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'RuleDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Transfer resources to which the {"env": "online"} and {"project": "A"} tags are added to the resource group rg-aek2********qcy.', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'* custom_condition: custom transfer rule'."\n" + .'* associated_transfer: transfer rule for associated resources'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'custom_condition', + 'enum' => [ + 'associated_transfer', + 'custom_condition', + ], + ], + ], + [ + 'name' => 'RuleContents', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The content records of the rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The content record of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => 'The condition for the range of resources to be automatically transferred.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + 'maxLength' => 50000, + ], + 'TargetResourceGroupCondition' => [ + 'description' => 'The condition for the destination resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}', + 'maxLength' => 255, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ResourceGroupIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resource groups. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq', + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'ExcludeResourceGroupIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resource groups to be excluded. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******zj2oi,rg-aekz******r62ua', + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'RegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of regions. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou,cn-shanghai', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeRegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of regions to be excluded. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing,cn-guangzhou', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resources. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ExcludeResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resources to be excluded. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-uf6p******4h784y,rmq-cn-******ny0y', + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource types. Separate multiple resource types with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds.dbinstance,oss.bucket', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource types to be excluded. Separate multiple resource types with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse.cluster,slb.loadbalancer', + 'maxLength' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F7701451-340B-5CB3-AEA7-7D831F7F38C0', + ], + 'RuleId' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'example' => 'gr-acfo******hy6a', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid.AssociatedTransferRule.AlreadyExisted', + 'errorMessage' => 'The associated transfer rule already exists.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceTypesScope', + 'errorMessage' => 'The parameter ResourceTypesScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ExcludeResourceTypesScope', + 'errorMessage' => 'The parameter ExcludeResourceTypesScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceGroupIdsScope', + 'errorMessage' => 'The parameter ResourceGroupIdsScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ExcludeResourceGroupIdsScope', + 'errorMessage' => 'The parameter ExcludeResourceGroupIdsScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothRegionIdScopes', + 'errorMessage' => 'The combination of parameters RegionIdsScope and ExcludeRegionIdsScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothResourceGroupIdScopes', + 'errorMessage' => 'The combination of parameters ResourceGroupIdsScope and ExcludeResourceGroupIdsScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothResourceIdScopes', + 'errorMessage' => 'The combination of parameters ResourceIdsScope and ExcludeResourceIdsScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothResourceTypeScopes', + 'errorMessage' => 'The combination of parameters ResourceTypesScope and ExcludeResourceTypesScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameter.RuleContents', + 'errorMessage' => 'The parameter RuleContents is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.RuleContents', + 'errorMessage' => 'The parameter RuleContents is required.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + [ + 'errorCode' => 'QuotaExceeded.RuleContent', + 'errorMessage' => 'The number of rule contents exceeds the quota.', + ], + [ + 'errorCode' => 'QuotaExceeded.GroupingRule', + 'errorMessage' => 'The number of grouping rules exceeds the quota.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7701451-340B-5CB3-AEA7-7D831F7F38C0\\",\\n \\"RuleId\\": \\"gr-acfo******hy6a\\"\\n}","type":"json"}]', + 'title' => 'CreateAutoGroupingRule', + 'description' => 'You can create up to 10 custom transfer rules. Each custom transfer rule can contain up to 10 content records.'."\n", + 'requestParamsDescription' => '### [](#-1)Example 1: Enable the system to automatically transfer resources based on tags'."\n" + ."\n" + .' {'."\n" + .' "RuleName": "Custom Transfer Rule for Online Resources of Project A",'."\n" + .' "RuleDesc": "Transfer resources to which the {\\"env\\": \\"online\\"} and {\\"project\\": \\"A\\"} tags are added to the resource group rg-aek2********qcy.",'."\n" + .' "RuleType": "custom_condition",'."\n" + .' "RuleContents": ['."\n" + .' {'."\n" + .' "AutoGroupingScopeCondition": "{\\"children\\":[{\\"desired\\":\\"{\\\\\\"env\\\\\\":\\\\\\"online\\\\\\", \\\\\\"project\\\\\\":\\\\\\"A\\\\\\"}\\",\\"featurePath\\":\\"$.tags\\",\\"featureSource\\":\\"RESOURCE\\",\\"operator\\":\\"TagMatchAll\\"}],\\"operator\\":\\"and\\"}",'."\n" + .' "TargetResourceGroupCondition": "{\\"children\\":[{\\"desired\\":\\"rg-aek2********qcy\\",\\"featurePath\\":\\"$.resourceGroupId\\",\\"featureSource\\":\\"RESOURCE\\",\\"operator\\":\\"StringEquals\\"}],\\"operator\\":\\"and\\"}"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + ."\n" + .'### [](#-2-ecs-)Example 2: Enable the system to automatically transfer resources together with an Elastic Compute Service (ECS) instance'."\n" + ."\n" + .' {'."\n" + .' "RuleName": "Cloud Disk Transferred Together with ECS Instance",'."\n" + .' "RuleDesc": "When a cloud disk is attached to an ECS instance or the ECS instance is transferred from a resource group to another, the cloud disk is automatically transferred to the resource group to which the ECS instance belongs.",'."\n" + .' "RuleType": "associated_transfer",'."\n" + .' "ResourceTypesScope": "ecs.disk",'."\n" + .' "RuleContents": ['."\n" + .' {'."\n" + .' "TargetResourceGroupCondition": "{\\"desired\\":\\"$.ResourceGroupId\\",\\"desiredSource\\":\\"RESOURCE_RELATIONSHIP_ACS::ECS::Instance\\",\\"featurePath\\":\\"$.ResourceGroupId\\",\\"featureSource\\":\\"CONFIGURATION\\",\\"operator\\":\\"StringEquals\\"}"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n", + ], + 'DeleteAutoGroupingRule' => [ + 'summary' => 'Deletes a transfer rule.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfo******hy6a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AutoGroupingRule', + 'errorMessage' => 'The specified rule is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","type":"json"}]', + 'title' => 'DeleteAutoGroupingRule', + ], + 'UpdateAutoGroupingRule' => [ + 'summary' => 'Updates a transfer rule.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfo******hy6a', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Custom Transfer Rule for Online Resources of Project A', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'RuleDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Transfer resources to which the {"env": "online"} and {"project": "A"} tags are added to the resource group rg-aek2********qcy.', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'RuleContents', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The content records of the rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The content record of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => 'The condition for the range of resources that are automatically transferred.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + 'maxLength' => 50000, + ], + 'RuleContentId' => [ + 'description' => 'The ID of the content record.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'grc-acfo******fwybpq', + ], + 'TargetResourceGroupCondition' => [ + 'description' => 'The condition for the destination resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}', + 'maxLength' => 255, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ResourceGroupIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resource groups. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq'."\n", + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'ExcludeResourceGroupIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resource groups to be excluded. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******zj2oi,rg-aekz******r62ua'."\n", + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'RegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of regions. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou,cn-shanghai'."\n", + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeRegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of regions to be excluded. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing,cn-guangzhou'."\n", + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resources. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a'."\n", + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ExcludeResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of resources to be excluded. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-uf6p******4h784y,rmq-cn-******ny0y', + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource types. Separate multiple resource types with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds.dbinstance,oss.bucket', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource types to be excluded. Separate multiple resource types with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse.cluster,slb.loadbalancer', + 'maxLength' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid.AssociatedTransferRule.NotSupported', + 'errorMessage' => 'The associated transfer rule is not supported for this operation.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceTypesScope', + 'errorMessage' => 'The parameter ResourceTypesScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ExcludeResourceTypesScope', + 'errorMessage' => 'The parameter ExcludeResourceTypesScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceGroupIdsScope', + 'errorMessage' => 'The parameter ResourceGroupIdsScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ExcludeResourceGroupIdsScope', + 'errorMessage' => 'The parameter ExcludeResourceGroupIdsScope is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothRegionIdScopes', + 'errorMessage' => 'The combination of parameters RegionIdsScope and ExcludeRegionIdsScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothResourceGroupIdScopes', + 'errorMessage' => 'The combination of parameters ResourceGroupIdsScope and ExcludeResourceGroupIdsScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothResourceIdScopes', + 'errorMessage' => 'The combination of parameters ResourceIdsScope and ExcludeResourceIdsScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameterCombination.BothResourceTypeScopes', + 'errorMessage' => 'The combination of parameters ResourceTypesScope and ExcludeResourceTypesScope is not allowed. Please select only one of these parameters.', + ], + [ + 'errorCode' => 'InvalidParameter.RuleContents', + 'errorMessage' => 'The parameter RuleContents is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.RuleContents', + 'errorMessage' => 'The parameter RuleContents is required.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AutoGroupingRule', + 'errorMessage' => 'The specified rule is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + [ + 'errorCode' => 'QuotaExceeded.RuleContent', + 'errorMessage' => 'The number of rule contents exceeds the quota.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\"\\n}","type":"json"}]', + 'title' => 'UpdateAutoGroupingRule', + ], + 'ListAutoGroupingRules' => [ + 'summary' => 'Queries a list of transfer rules.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gr-acfo******hy6a', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Custom Transfer Rule for Online Resources of Project A', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'* custom_condition: custom transfer rule'."\n" + .'* associated_transfer: transfer rule for associated resources'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'custom_condition'."\n", + 'enum' => [ + 'associated_transfer', + 'custom_condition', + ], + ], + ], + [ + '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. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request. Valid values: 1 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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' => 'TGlzdFJlc291cm****', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned for a single request. Valid values: 1 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Rules' => [ + 'description' => 'The queried rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'The time when the rule was created.'."\n", + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'ExcludeRegionIdsScope' => [ + 'description' => 'The IDs of excluded regions. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai'."\n", + ], + 'ExcludeResourceGroupIdsScope' => [ + 'description' => 'The IDs of excluded resource groups. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'rg-aekz****ql4b5ea,rg-aek2****akfxykq'."\n", + ], + 'ExcludeResourceIdsScope' => [ + 'description' => 'The IDs of excluded resources. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a'."\n", + ], + 'ExcludeResourceTypesScope' => [ + 'description' => 'The excluded resource types. Multiple resource types are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc'."\n", + ], + 'ModifyTime' => [ + 'description' => 'The time when the rule was updated.'."\n", + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'RegionIdsScope' => [ + 'description' => 'The IDs of regions. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai'."\n", + ], + 'ResourceGroupIdsScope' => [ + 'description' => 'The IDs of resource groups. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'rg-aekz****ql4b5ea,rg-aek2****akfxykq'."\n", + ], + 'ResourceIdsScope' => [ + 'description' => 'The IDs of resources. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a'."\n", + ], + 'ResourceTypesScope' => [ + 'description' => 'The resource types. Multiple resource types are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc'."\n", + ], + 'RuleContents' => [ + 'description' => 'The content records of the rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The content record of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => 'The condition for the range of resources that are automatically transferred.'."\n", + 'type' => 'string', + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + ], + 'RuleContentId' => [ + 'description' => 'The ID of the content record.'."\n", + 'type' => 'string', + 'example' => 'grc-acfo******fwybpq', + ], + 'TargetResourceGroupCondition' => [ + 'description' => 'The condition for the destination resource group.'."\n", + 'type' => 'string', + 'example' => '{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}', + ], + ], + ], + ], + 'RuleDesc' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'example' => 'Transfer resources to which the {"env": "online"} and {"project": "A"} tags are added to the resource group rg-aek2********qcy.', + ], + 'RuleId' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'example' => 'gr-acfo******hy6a'."\n", + ], + 'RuleName' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'example' => 'Custom Transfer Rule for Online Resources of Project A', + ], + 'RuleType' => [ + 'description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'* custom_condition: custom transfer rule'."\n" + .'* associated_transfer: transfer rule for associated resources'."\n", + 'type' => 'string', + 'example' => 'custom_condition', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The parameter NextToken is invalid.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"MaxResults\\": 10,\\n \\"Rules\\": [\\n {\\n \\"CreateTime\\": \\"2025-01-01T10:00:00+08:00\\",\\n \\"ExcludeRegionIdsScope\\": \\"cn-hangzhou,cn-shanghai\\",\\n \\"ExcludeResourceGroupIdsScope\\": \\"rg-aekz****ql4b5ea,rg-aek2****akfxykq\\",\\n \\"ExcludeResourceIdsScope\\": \\"i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a\\",\\n \\"ExcludeResourceTypesScope\\": \\"ecs.instance,vpc.vpc\\",\\n \\"ModifyTime\\": \\"2025-01-01T10:00:00+08:00\\",\\n \\"RegionIdsScope\\": \\"cn-hangzhou,cn-shanghai\\",\\n \\"ResourceGroupIdsScope\\": \\"rg-aekz****ql4b5ea,rg-aek2****akfxykq\\",\\n \\"ResourceIdsScope\\": \\"i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a\\",\\n \\"ResourceTypesScope\\": \\"ecs.instance,vpc.vpc\\",\\n \\"RuleContents\\": [\\n {\\n \\"AutoGroupingScopeCondition\\": \\"{\\\\\\"children\\\\\\":[{\\\\\\"desired\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"env\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"online\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"A\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"featurePath\\\\\\":\\\\\\"$.tags\\\\\\",\\\\\\"featureSource\\\\\\":\\\\\\"RESOURCE\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"TagMatchAll\\\\\\"}],\\\\\\"operator\\\\\\":\\\\\\"and\\\\\\"}\\",\\n \\"RuleContentId\\": \\"grc-acfo******fwybpq\\",\\n \\"TargetResourceGroupCondition\\": \\"{\\\\\\"children\\\\\\":[{\\\\\\"desired\\\\\\":\\\\\\"rg-aek2********qcy\\\\\\",\\\\\\"featurePath\\\\\\":\\\\\\"$.resourceGroupId\\\\\\",\\\\\\"featureSource\\\\\\":\\\\\\"RESOURCE\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"StringEquals\\\\\\"}],\\\\\\"operator\\\\\\":\\\\\\"and\\\\\\"}\\"\\n }\\n ],\\n \\"RuleDesc\\": \\"带有标签 {\\\\\\"env\\\\\\": \\\\\\"online\\\\\\"} 和 {\\\\\\"project\\\\\\": \\\\\\"A\\\\\\"} 的资源转移到资源组rg-aek2********qcy\\",\\n \\"RuleId\\": \\"gr-acfo******hy6a\\\\n\\",\\n \\"RuleName\\": \\"A项目线上资源自动转组规则\\",\\n \\"RuleType\\": \\"custom_condition\\"\\n }\\n ],\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","type":"json"}]', + 'title' => 'ListAutoGroupingRules', + ], + 'GetAutoGroupingRule' => [ + 'summary' => 'Queries the information about a transfer rule.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfo******hy6a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'description' => 'The information about the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'The time when the rule was created.'."\n", + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'ExcludeRegionIdsScope' => [ + 'description' => 'The IDs of excluded regions. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai'."\n", + ], + 'ExcludeResourceGroupIdsScope' => [ + 'description' => 'The IDs of excluded resource groups. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq'."\n", + ], + 'ExcludeResourceIdsScope' => [ + 'description' => 'The IDs of excluded resources. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + ], + 'ExcludeResourceTypesScope' => [ + 'description' => 'The excluded resource types. Multiple resource types are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc', + ], + 'ModifyTime' => [ + 'description' => 'The time when the rule was modified.'."\n", + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'RegionIdsScope' => [ + 'description' => 'The IDs of regions. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai', + ], + 'ResourceGroupIdsScope' => [ + 'description' => 'The IDs of resource groups. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq'."\n", + ], + 'ResourceIdsScope' => [ + 'description' => 'The IDs of resources. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + ], + 'ResourceTypesScope' => [ + 'description' => 'The resource types. Multiple resource types are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc', + ], + 'RuleContents' => [ + 'description' => 'The content records of the rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The content record of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => 'The condition for the range of resources that are automatically transferred.'."\n", + 'type' => 'string', + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + ], + 'RuleContentId' => [ + 'description' => 'The ID of the content record.'."\n", + 'type' => 'string', + 'example' => 'grc-acfo******fwybpq', + ], + 'TargetResourceGroupCondition' => [ + 'description' => 'The condition for the destination resource group.'."\n", + 'type' => 'string', + 'example' => '{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}', + ], + ], + ], + ], + 'RuleDesc' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'example' => 'Transfer resources to which the {"env": "online"} and {"project": "A"} tags are added to the resource group rg-aek2********qcy.', + ], + 'RuleId' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'example' => 'gr-acfo******hy6a', + ], + 'RuleName' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'example' => 'Custom Transfer Rule for Online Resources of Project A', + ], + 'RuleType' => [ + 'description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'* custom_condition: custom transfer rule'."\n" + .'* associated_transfer: transfer rule for associated resources'."\n", + 'type' => 'string', + 'example' => 'associated_transfer', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AutoGroupingRule', + 'errorMessage' => 'The specified rule is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Rule\\": {\\n \\"CreateTime\\": \\"2025-01-01T10:00:00+08:00\\",\\n \\"ExcludeRegionIdsScope\\": \\"cn-hangzhou,cn-shanghai\\",\\n \\"ExcludeResourceGroupIdsScope\\": \\"rg-aekz******4b5ea,rg-aek2******fxykq\\",\\n \\"ExcludeResourceIdsScope\\": \\"i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a\\",\\n \\"ExcludeResourceTypesScope\\": \\"ecs.instance,vpc.vpc\\",\\n \\"ModifyTime\\": \\"2025-01-01T10:00:00+08:00\\",\\n \\"RegionIdsScope\\": \\"cn-hangzhou,cn-shanghai\\",\\n \\"ResourceGroupIdsScope\\": \\"rg-aekz******4b5ea,rg-aek2******fxykq\\",\\n \\"ResourceIdsScope\\": \\"i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a\\",\\n \\"ResourceTypesScope\\": \\"ecs.instance,vpc.vpc\\",\\n \\"RuleContents\\": [\\n {\\n \\"AutoGroupingScopeCondition\\": \\"{\\\\\\"children\\\\\\":[{\\\\\\"desired\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"env\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"online\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"A\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"featurePath\\\\\\":\\\\\\"$.tags\\\\\\",\\\\\\"featureSource\\\\\\":\\\\\\"RESOURCE\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"TagMatchAll\\\\\\"}],\\\\\\"operator\\\\\\":\\\\\\"and\\\\\\"}\\",\\n \\"RuleContentId\\": \\"grc-acfo******fwybpq\\",\\n \\"TargetResourceGroupCondition\\": \\"{\\\\\\"children\\\\\\":[{\\\\\\"desired\\\\\\":\\\\\\"rg-aek2********qcy\\\\\\",\\\\\\"featurePath\\\\\\":\\\\\\"$.resourceGroupId\\\\\\",\\\\\\"featureSource\\\\\\":\\\\\\"RESOURCE\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"StringEquals\\\\\\"}],\\\\\\"operator\\\\\\":\\\\\\"and\\\\\\"}\\"\\n }\\n ],\\n \\"RuleDesc\\": \\"带有标签 {\\\\\\"env\\\\\\": \\\\\\"online\\\\\\"} 和 {\\\\\\"project\\\\\\": \\\\\\"A\\\\\\"} 的资源转移到资源组rg-aek2********qcy\\",\\n \\"RuleId\\": \\"gr-acfo******hy6a\\",\\n \\"RuleName\\": \\"A项目线上资源自动转组规则\\",\\n \\"RuleType\\": \\"associated_transfer\\"\\n },\\n \\"RequestId\\": \\"9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC\\"\\n}","type":"json"}]', + 'title' => 'GetAutoGroupingRule', + ], + 'EnableAssociatedTransfer' => [ + 'summary' => 'Enables the Transfer Associated Resources feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484114', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedOperation.RepeatEnableAssociatedTransferSetting', + 'errorMessage' => 'Repeat enable associated transfer setting is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484114\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableAssociatedTransferResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF5189484114</RequestId>\\n</EnableAssociatedTransferResponse>","errorExample":""}]', + 'title' => 'EnableAssociatedTransfer', + ], + 'DisableAssociatedTransfer' => [ + 'summary' => 'Disables the Transfer Associated Resources feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7CE0AE54-6F27-5522-A429-4C5EE8FD40C8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedOperation.RepeatDisableAssociatedTransferSetting', + 'errorMessage' => 'Repeat disable associated transfer setting is not supported.', + ], + [ + 'errorCode' => 'UnsupportedOperation.DisableAssociatedTransferSetting', + 'errorMessage' => 'UnsupportedOperation.DisableAssociatedTransferSetting', + ], + [ + 'errorCode' => 'EntityExists.AssociatedTransferTasks', + 'errorMessage' => 'Disable associated transfer setting is not supported when associated transfer task exists.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CE0AE54-6F27-5522-A429-4C5EE8FD40C8\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAssociatedTransferResponse>\\n <RequestId>7CE0AE54-6F27-5522-A429-4C5EE8FD40C8</RequestId>\\n</DisableAssociatedTransferResponse>","errorExample":""}]', + 'title' => 'DisableAssociatedTransfer', + ], + 'UpdateAssociatedTransferSetting' => [ + 'summary' => 'Updates the settings of the Transfer Associated Resources feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleSettings', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The settings of transfer rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The settings of transfer rules.'."\n", + 'type' => 'object', + 'properties' => [ + 'AssociatedResourceType' => [ + 'description' => 'The type of the associated resource.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'disk', + ], + 'AssociatedService' => [ + 'description' => 'The service code of the associated resource.'."\n" + ."\n" + .'You can obtain the service code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'MasterResourceType' => [ + 'description' => 'The type of the primary resource.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'MasterService' => [ + 'description' => 'The service code of the primary resource.'."\n" + ."\n" + .'You can obtain the service code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Status' => [ + 'description' => 'The status of the Transfer Associated Resources feature. Valid values:'."\n" + ."\n" + .'* Enable: enabled'."\n" + .'* Disable: disabled'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableExistingResourcesTransfer', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the Transfer Existing Associated Resources feature. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedOperation.UpdateAssociatedTransferRuleSetting', + 'errorMessage' => 'Updating associated transfer rule setting before open associated transfer is not supported.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AssociatedTransferRule', + 'errorMessage' => 'The associated transfer rule does not EXIST.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAssociatedTransferSettingResponse>\\n <RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\n</UpdateAssociatedTransferSettingResponse>","errorExample":""}]', + 'title' => 'UpdateAssociatedTransferSetting', + 'description' => 'For information about the resources that support the Transfer Associated Resources feature, see [Use the Transfer Associated Resources feature](~~606232~~).'."\n", + ], + 'ListAssociatedTransferSetting' => [ + 'summary' => 'Queries the settings of the Transfer Associated Resources feature.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'AssociatedTransferSetting' => [ + 'description' => 'The settings of the Transfer Associated Resources feature.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '121998723923****', + ], + 'EnableExistingResourcesTransfer' => [ + 'description' => 'Indicates whether the Transfer Existing Associated Resources feature is enabled. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RuleSettings' => [ + 'description' => 'The settings of transfer rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The settings of transfer rules.'."\n", + 'type' => 'object', + 'properties' => [ + 'AssociatedResourceType' => [ + 'description' => 'The type of the associated resource.'."\n", + 'type' => 'string', + 'example' => 'disk', + ], + 'AssociatedService' => [ + 'description' => 'The service code of the associated resource.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'MasterResourceType' => [ + 'description' => 'The type of the primary resource.'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'MasterService' => [ + 'description' => 'The service code of the primary resource.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'Status' => [ + 'description' => 'The status of the Transfer Associated Resources feature. Valid values:'."\n" + ."\n" + .'* Enable: enabled'."\n" + .'* Disable: disabled'."\n", + 'type' => 'string', + 'example' => 'Enable', + ], + ], + ], + ], + 'Status' => [ + 'description' => 'The status of the Transfer Associated Resources feature. Valid values:'."\n" + ."\n" + .'* Enable: enabled'."\n" + .'* Disable: disabled'."\n", + 'type' => 'string', + 'example' => 'Enable', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7556FD65-45D2-5C45-9FC9-A7DE831C775C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AssociatedTransferSetting', + 'errorMessage' => 'The associated transfer setting does not EXIST.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AssociatedTransferSetting\\": {\\n \\"AccountId\\": \\"121998723923****\\",\\n \\"EnableExistingResourcesTransfer\\": \\"true\\",\\n \\"RuleSettings\\": [\\n {\\n \\"AssociatedResourceType\\": \\"disk\\",\\n \\"AssociatedService\\": \\"ecs\\",\\n \\"MasterResourceType\\": \\"instance\\",\\n \\"MasterService\\": \\"ecs\\",\\n \\"Status\\": \\"Enable\\"\\n }\\n ],\\n \\"Status\\": \\"Enable\\"\\n },\\n \\"RequestId\\": \\"7556FD65-45D2-5C45-9FC9-A7DE831C775C\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAssociatedTransferSettingResponse>\\n <RequestId>7556FD65-45D2-5C45-9FC9-A7DE831C775C</RequestId>\\n <AssociatedTransferSetting>\\n <AccountId>121998723923****</AccountId>\\n <Status>Enable</Status>\\n <RuleSettings>\\n <AssociatedResourceType>disk</AssociatedResourceType>\\n <MasterResourceType>instance</MasterResourceType>\\n <AssociatedService>ecs</AssociatedService>\\n <MasterService>ecs</MasterService>\\n <Status>Enable</Status>\\n </RuleSettings>\\n <EnableExistingResourcesTransfer>true</EnableExistingResourcesTransfer>\\n </AssociatedTransferSetting>\\n</ListAssociatedTransferSettingResponse>","errorExample":""}]', + 'title' => 'ListAssociatedTransferSetting', + ], + 'GetResourceGroupResourceCounts' => [ + 'summary' => 'Queries the number of resources in a visible resource group.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceTypeCode' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The service code.'."\n" + ."\n" + .'You can obtain the code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'GroupByKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dimension by which resources are queried.'."\n" + ."\n" + .'> If you do not specify a dimension, no results are returned.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ResourceGroupId'."\n" + .'* ResourceType'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ResourceGroupId' => '', + 'ResourceType' => '', + ], + 'example' => 'ResourceGroupId', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~2716558~~) operation to obtain the ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the resources.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'ResourceCounts' => [ + 'description' => 'The numbers of the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The number of the resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => 'The number of the resources.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GroupByKey' => [ + 'description' => 'The dimension by which resources are queried.'."\n", + 'type' => 'string', + 'example' => 'ResourceGroupId', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedResourceType', + 'errorMessage' => 'The resource type is not supported.', + ], + [ + 'errorCode' => 'InvalidParameter.GroupByKey', + 'errorMessage' => 'The parameter GroupByKey is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"ResourceCounts\\": [\\n {\\n \\"Count\\": 1,\\n \\"GroupByKey\\": \\"ResourceGroupId\\",\\n \\"ResourceGroupId\\": \\"rg-9gLOoK****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetResourceGroupResourceCounts', + ], + 'ListAutoGroupingRemediations' => [ + 'summary' => 'Queries a list of automatic grouping remediation records.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置,置空表示从头开始', + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If you leave this parameter empty, the query starts from the beginning.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => 'The maximum number of data entries to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfnugygwms32yy', + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n" + ."\n" + .'You can obtain the ID from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type,'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource ID,'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-23v38****', + ], + ], + [ + 'name' => 'TargetResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the new resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz26emqhc****', + ], + ], + [ + 'name' => 'EarliestRemediationTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest remediation time. This parameter is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01 00:00:00', + ], + ], + [ + 'name' => 'LatestRemediationTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest remediation time. This parameter is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-01 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'Remediations' => [ + 'description' => 'The remediation records.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The remediation record.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'RemediationId' => [ + 'description' => 'The remediation record ID.'."\n", + 'type' => 'string', + 'example' => '0028d4****cfe94956ef6708a373f396fbc840e306f', + ], + 'RemediationTime' => [ + 'description' => 'The remediation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-01 00:00:00', + ], + 'ResourceId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'i-uf664f66v1****drkea4', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n" + ."\n" + .'You can obtain the ID from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'TargetResourceGroupInfo' => [ + 'description' => 'The information about the new resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupDisplayName' => [ + 'description' => 'The resource group name.'."\n", + 'type' => 'string', + 'example' => 'ProjectA', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmygrk****wfa', + ], + ], + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6F959E33-7B6D-5F58-BB0B-ED616DC7C70B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'AutoGroupingNotEnabled', + 'errorMessage' => 'The auto grouping is disabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"Remediations\\": [\\n {\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"RemediationId\\": \\"0028d4****cfe94956ef6708a373f396fbc840e306f\\",\\n \\"RemediationTime\\": \\"2022-01-01 00:00:00\\",\\n \\"ResourceId\\": \\"i-uf664f66v1****drkea4\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Service\\": \\"ecs\\",\\n \\"TargetResourceGroupInfo\\": {\\n \\"ResourceGroupDisplayName\\": \\"ProjectA\\",\\n \\"ResourceGroupId\\": \\"rg-acfmygrk****wfa\\"\\n }\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"RequestId\\": \\"6F959E33-7B6D-5F58-BB0B-ED616DC7C70B\\"\\n}","type":"json"}]', + 'title' => 'ListAutoGroupingRemediations', + ], + 'GetResourceGroupAdminSetting' => [ + 'summary' => 'Queries the configurations of a resource group administrator.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreatorAsAdmin' => [ + 'description' => 'Indicates whether enable the Use Creator as Administrator feature.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '776B05B3-A0B0-464B-A191-F4E1119A94B2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CreatorAsAdmin\\": true,\\n \\"RequestId\\": \\"776B05B3-A0B0-464B-A191-F4E1119A94B2\\"\\n}","type":"json"}]', + 'title' => 'GetResourceGroupAdminSetting', + ], + 'UpdateResourceGroupAdminSetting' => [ + 'summary' => 'Updates the configurations of a resource group administrator.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CreatorAsAdmin', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the Use Creator as Administrator feature.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","type":"json"}]', + 'title' => 'UpdateResourceGroupAdminSetting', + ], + 'LookupResourceGroupEvents' => [ + 'summary' => 'Queries the events of resource groups.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-30 23:43:16', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-30 23:43:16', + ], + ], + [ + 'name' => 'EventCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The event type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MemberShipChange', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + '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. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'LookupAttributes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The attributes used for advanced search.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the attribute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ProjectA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Events' => [ + 'description' => 'The queried events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the event.'."\n", + 'type' => 'object', + 'properties' => [ + 'ChangeType' => [ + 'description' => 'The type of the resource change event.'."\n", + 'type' => 'string', + 'example' => 'Add', + ], + 'EventTime' => [ + 'description' => 'The time when the event was triggered.'."\n", + 'type' => 'string', + 'example' => '2025-12-04T18:35:17Z', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'ResourceGroupDisplayName' => [ + 'description' => 'The resource group name.'."\n", + 'type' => 'string', + 'example' => 'ProjectA', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfm2sohr74****', + ], + 'ResourceId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'i-wz9fpfe64****', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The service code.'."\n" + ."\n" + .'You can obtain the code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'SourceResourceGroupInfo' => [ + 'description' => 'The source resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupDisplayName' => [ + 'description' => 'The resource group name.'."\n", + 'type' => 'string', + 'example' => 'TestGroupA', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-aekz25pfurj****', + ], + ], + ], + 'TargetResourceGroupInfo' => [ + 'description' => 'The destination resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupDisplayName' => [ + 'description' => 'The resource group name.'."\n", + 'type' => 'string', + 'example' => 'TestGroupB', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmwfrxcre****', + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F7701451-340B-5CB3-AEA7-7D831F7F****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Events\\": [\\n {\\n \\"ChangeType\\": \\"Add\\",\\n \\"EventTime\\": \\"2025-12-04T18:35:17Z\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ResourceGroupDisplayName\\": \\"ProjectA\\",\\n \\"ResourceGroupId\\": \\"rg-acfm2sohr74****\\",\\n \\"ResourceId\\": \\"i-wz9fpfe64****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Service\\": \\"ecs\\",\\n \\"SourceResourceGroupInfo\\": {\\n \\"ResourceGroupDisplayName\\": \\"TestGroupA\\",\\n \\"ResourceGroupId\\": \\"rg-aekz25pfurj****\\"\\n },\\n \\"TargetResourceGroupInfo\\": {\\n \\"ResourceGroupDisplayName\\": \\"TestGroupB\\",\\n \\"ResourceGroupId\\": \\"rg-acfmwfrxcre****\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"F7701451-340B-5CB3-AEA7-7D831F7F****\\"\\n}","type":"json"}]', + 'title' => 'LookupResourceGroupEvents', + ], + 'EnableResourceGroupNotification' => [ + 'summary' => 'Enables group event notification.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F7701451-340B-5CB3-AEA7-7D831F7F38C0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'UnsupportedOperation.RepeatEnableResourceGroupNotification', + 'errorMessage' => 'The resource group notification is already enabled. Please do not repeat the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7701451-340B-5CB3-AEA7-7D831F7F38C0\\"\\n}","type":"json"}]', + 'title' => 'EnableResourceGroupNotification', + ], + 'DisableResourceGroupNotification' => [ + 'summary' => 'Disables group event notification.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '898FAB24-7509-43EE-A287-086FE4C44394', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'UnsupportedOperation.RepeatDisableResourceGroupNotification', + 'errorMessage' => 'The resource group notification is already disabled. Please do not repeat the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}","type":"json"}]', + 'title' => 'DisableResourceGroupNotification', + ], + 'GetResourceGroupNotificationSetting' => [ + 'summary' => 'Queries the notification settings of a resource group.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleND70KM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F70D09B-0EE5-54A6-A09A-1EBDB9297172', + ], + 'ResourceGroupNotificationEnableStatus' => [ + 'description' => 'Indicates whether the group event notification is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F70D09B-0EE5-54A6-A09A-1EBDB9297172\\",\\n \\"ResourceGroupNotificationEnableStatus\\": true\\n}","type":"json"}]', + 'title' => 'GetResourceGroupNotificationSetting', + ], + 'ListResourceGroupCapability' => [ + 'summary' => 'Queries whether a specific resource type or a given cloud service supports resource group events.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n" + ."\n" + .'You can obtain the service code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'SupportResourceGroupEvent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether a specific resource type or cloud service supports resource group events.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Capabilities' => [ + 'description' => 'Indicates whether a specific resource type or cloud service supports resource group events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Indicates whether a specific resource type or cloud service supports resource group events.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The service code.'."\n" + ."\n" + .'You can obtain the code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'SupportResourceGroupEvent' => [ + 'description' => 'Indicates whether a specific resource type or cloud service supports resource group events.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2CB870A2-DF0F-5338-8223-F64737FF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Capabilities\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"Service\\": \\"ecs\\",\\n \\"SupportResourceGroupEvent\\": true\\n }\\n ],\\n \\"RequestId\\": \\"2CB870A2-DF0F-5338-8223-F64737FF****\\"\\n}","type":"json"}]', + 'title' => 'ListResourceGroupCapability', + ], + 'ListResourceGroupsWithAuthDetails' => [ + 'summary' => 'Queries resource groups and their user authorization information.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the resource group. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the resource group. This parameter specifies a filter condition for the query. Fuzzy search is supported.'."\n" + ."\n" + .'The display name can be a maximum of 50 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestRG-BVT1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the resource group. This parameter specifies a filter condition for the query. Fuzzy search is supported.'."\n" + ."\n" + .'The identifier can be a maximum of 50 characters in length and can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prod-rg', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n" + ."\n" + .'> If you set a tag filter condition, the tag information is returned regardless of the `IncludeTags` value.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The IDs of the resource groups that you want to query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the resource groups that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3uwewyefzuy', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource types.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceTypeCode' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The service code.'."\n" + ."\n" + .'You can obtain the code from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the resource resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AuthDetails' => [ + 'description' => 'The authorization details for resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The authorization details for a type of resource groups.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountScopeAuth' => [ + 'description' => 'Indicates whether the user has account-level authorization for this resource type.'."\n", + 'type' => 'boolean', + ], + 'AuthOfResourceGroups' => [ + 'description' => 'The permission details for the resource groups on the specified resource types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permission details for the resource groups on the specified resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'HasPermission' => [ + 'description' => 'Indicates whether the user has permissions on the resource group for the specified resource type.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-aekzscexx6w3u2y', + ], + ], + ], + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'You can obtain the resource type from the **Resource type** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => 'The ID of the Alibaba Cloud service.'."\n" + ."\n" + .'You can obtain the ID from the **Service code** column in [Services that work with Resource Group](~~94479~~).'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The response parameters.'."\n", + 'type' => 'string', + 'example' => '4141780B-4E3D-5D2A-A8F4-44D6D34F****', + ], + 'ResourceGroups' => [ + 'description' => 'The information of the resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource group belongs.'."\n", + 'type' => 'string', + 'example' => '123456789****', + ], + 'CreateDate' => [ + 'description' => 'The time when the resource group was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DisplayName' => [ + 'description' => 'The display name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => 'The ID of your Alibaba Cloud resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => 'The unique identifier of the resource group.'."\n", + 'type' => 'string', + 'example' => 'my-project', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* Creating: The resource group is being created.'."\n" + .'* OK: The resource group is created.'."\n" + .'* PendingDelete: The resource group is waiting to be deleted.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthDetails\\": [\\n {\\n \\"AccountScopeAuth\\": true,\\n \\"AuthOfResourceGroups\\": [\\n {\\n \\"HasPermission\\": true,\\n \\"ResourceGroupId\\": \\"rg-aekzscexx6w3u2y\\"\\n }\\n ],\\n \\"ResourceType\\": \\"instance\\",\\n \\"Service\\": \\"ecs\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4141780B-4E3D-5D2A-A8F4-44D6D34F****\\",\\n \\"ResourceGroups\\": [\\n {\\n \\"AccountId\\": \\"123456789****\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"DisplayName\\": \\"my-project\\",\\n \\"Id\\": \\"rg-9gLOoK****\\",\\n \\"Name\\": \\"my-project\\",\\n \\"Status\\": \\"OK\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"k1\\",\\n \\"TagValue\\": \\"v1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","type":"json"}]', + 'title' => 'ListResourceGroupsWithAuthDetails', + ], + 'CreateRole' => [ + 'summary' => 'Creates a RAM role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the role.'."\n" + ."\n" + .'The name must be 1 to 64 characters in length, and can contain letters, digits, periods (.), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the role.'."\n" + ."\n" + .'The description must be 1 to 1,024 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS administrator', + ], + ], + [ + 'name' => 'AssumeRolePolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'The document of the policy that specifies'."\n" + ."\n" + .'one or more trusted entities to assume the role. The trusted entities can be Alibaba Cloud accounts, Alibaba Cloud services, or identity providers (IdPs).'."\n" + ."\n" + .'> RAM users cannot assume the RAM roles of trusted Alibaba Cloud services.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }', + ], + ], + [ + 'name' => 'MaxSessionDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum session duration of the role.'."\n" + ."\n" + .'Valid values: 3600 to 43200. Unit: seconds. Default value: 3600.'."\n" + ."\n" + .'If you do not specify this parameter, the default value is used.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Role' => [ + 'description' => 'The information about the role.'."\n", + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => 'The document of the policy in which the entity that can assume the role is specified.'."\n", + 'type' => 'string', + 'example' => '{ \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::12345678901234****:root\\" } } ], \\"Version\\": \\"1\\" }', + ], + 'CreateDate' => [ + 'description' => 'The time when the role was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => 'The description of the role.'."\n", + 'type' => 'string', + 'example' => 'ECS administrator', + ], + 'MaxSessionDuration' => [ + 'description' => 'The maximum session duration of the role.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => 'The ID of the role.'."\n", + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => 'The name of the role.'."\n", + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => 'The name of the role after authorization.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.RoleName.InvalidChars', + 'errorMessage' => 'The specified role name contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidParameter.RoleName.Length', + 'errorMessage' => 'The maximum length of the role name is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.AssumeRolePolicyDocument.Length', + 'errorMessage' => 'The maximum length of the trust policy document of the role is exceeded.', + ], + ], + 409 => [ + [ + 'errorCode' => 'EntityAlreadyExists.Role', + 'errorMessage' => 'The role already exists.', + ], + [ + 'errorCode' => 'MalformedPolicyDocument', + 'errorMessage' => 'The policy format is invalid.', + ], + [ + 'errorCode' => 'LimitExceeded.Role', + 'errorMessage' => 'The maximum number of roles is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Role\\": {\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\",\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [ { \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"sts:AssumeRole\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"RAM\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"acs:ram::12345678901234****:root\\\\\\\\\\\\\\" } } ], \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\" }\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleId\\": \\"90123456789****\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"RolePrincipalName\\": \\"[email protected]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateRoleResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n\\t<Role>\\r\\n\\t\\t<RoleId>90123456789****</RoleId>\\r\\n\\t\\t<RoleName>ECSAdmin</RoleName>\\r\\n\\t\\t<RolePrincipalName>[email protected]</RolePrincipalName>\\r\\n\\t\\t<Arn>acs:ram::123456789012****:role/ECSAdmin</Arn>\\r\\n\\t\\t<Description>ECS管理角色</Description>\\r\\n\\t\\t<MaxSessionDuration>3600</MaxSessionDuration>\\r\\n\\t\\t<AssumeRolePolicyDocument>{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }</AssumeRolePolicyDocument>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t</Role>\\r\\n</CreateRoleResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'CreateRole', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRole' => [ + 'summary' => 'Deletes a RAM role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the role.'."\n" + ."\n" + .'The name must be 1 to 64 characters in length and can contain letters, digits, periods (.), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '898FAB24-7509-43EE-A287-086FE4C44394', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.RoleName.InvalidChars', + 'errorMessage' => 'The specified role name contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidParameter.RoleName.Length', + 'errorMessage' => 'The maximum length of the role name is exceeded.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DeleteConflict.Role.Policy', + 'errorMessage' => 'The role cannot have any attached policies when you delete it.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\r\\n<DeleteRoleResponse>\\r\\n <RequestId type=\\"string\\">898FAB24-7509-43EE-A287-086FE4C44394</RequestId>\\r\\n</DeleteRoleResponse>","errorExample":""}]', + 'title' => 'DeleteRole', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateRole' => [ + 'summary' => 'Updates the information about a Resource Access Management (RAM) role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role.'."\n" + ."\n" + .'The name must be 1 to 64 characters in length, and can contain letters, digits, periods (.), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + [ + 'name' => 'NewAssumeRolePolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'The trust policy of the RAM role.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }', + ], + ], + [ + 'name' => 'NewMaxSessionDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum session time of the RAM role.'."\n" + ."\n" + .'Valid values: 3600 to 43200. Unit: seconds. Default value: 3600.'."\n" + ."\n" + .'If you do not specify this parameter, the default value is used.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'NewDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the RAM role.'."\n" + ."\n" + .'The description must be 1 to 1,024 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS administrator', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Role' => [ + 'description' => 'The information about the RAM role.'."\n", + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => 'The trust policy of the RAM role.'."\n", + 'type' => 'string', + 'example' => '{ \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::12345678901234****:root\\" } } ], \\"Version\\": \\"1\\" }', + ], + 'CreateDate' => [ + 'description' => 'The time when the RAM role was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => 'The description of the RAM role.'."\n", + 'type' => 'string', + 'example' => 'ECS administrator', + ], + 'MaxSessionDuration' => [ + 'description' => 'The maximum session time of the RAM role.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => 'The ID of the RAM role.'."\n", + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => 'The name of the RAM role.'."\n", + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => 'The name of the RAM role after authorization.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'UpdateDate' => [ + 'description' => 'The time when the RAM role was updated.'."\n", + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.RoleName.InvalidChars', + 'errorMessage' => 'The specified role name contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidParameter.RoleName.Length', + 'errorMessage' => 'The maximum length of the role name is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.NewAssumeRolePolicyDocument.Length', + 'errorMessage' => 'The maximum length of the new trust policy document of the role is exceeded.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'MalformedPolicyDocument', + 'errorMessage' => 'The policy format is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Role\\": {\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\",\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [ { \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"sts:AssumeRole\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"RAM\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"acs:ram::12345678901234****:root\\\\\\\\\\\\\\" } } ], \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\" }\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleId\\": \\"90123456789****\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"RolePrincipalName\\": \\"[email protected]\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateRoleResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n\\t<Role>\\r\\n\\t\\t<RoleId>90123456789****</RoleId>\\r\\n\\t\\t<RoleName>ECSAdmin</RoleName>\\r\\n\\t\\t<RolePrincipalName>[email protected]</RolePrincipalName>\\r\\n\\t\\t<Arn>acs:ram::123456789012****:role/ECSAdmin</Arn>\\r\\n\\t\\t<Description>ECS管理角色</Description>\\r\\n <MaxSessionDuration>3600</MaxSessionDuration>\\r\\n\\t\\t<AssumeRolePolicyDocument>{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }</AssumeRolePolicyDocument>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t<UpdateDate>2016-01-23T12:33:18Z</UpdateDate>\\r\\n\\t</Role>\\r\\n</UpdateRoleResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'UpdateRole', + 'description' => 'In this example, the description of the RAM role `ECSAdmin` is updated to `ECS administrator`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetRole' => [ + 'summary' => 'Queries the information about a RAM role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the role.'."\n" + ."\n" + .'The name must be 1 to 64 characters in length, and can contain letters, digits, periods (.), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the description of the role. Valid values:'."\n" + ."\n" + .'* en: English'."\n" + .'* zh-CN: Chinese'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Role' => [ + 'description' => 'The information about the role.'."\n", + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => 'The document of the policy in which the identity that can assume the role is specified.'."\n", + 'type' => 'string', + 'example' => '{ \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::12345678901234****:root\\" } } ], \\"Version\\": \\"1\\" }', + ], + 'CreateDate' => [ + 'description' => 'The time when the role was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => 'The description of the role.'."\n", + 'type' => 'string', + 'example' => 'ECS administrator', + ], + 'IsServiceLinkedRole' => [ + 'description' => 'Indicates whether the role is a service-linked role.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LatestDeletionTask' => [ + 'description' => 'The information of the most recent deletion task.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the deletion task was created.'."\n", + 'type' => 'string', + 'example' => '2018-10-23T12:33:18Z', + ], + 'DeletionTaskId' => [ + 'description' => 'The ID of the deletion task.'."\n", + 'type' => 'string', + 'example' => 'ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d', + ], + ], + ], + 'MaxSessionDuration' => [ + 'description' => 'The maximum session duration of the role.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => 'The ID of the role.'."\n", + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => 'The name of the role.'."\n", + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => 'The name of the role after authorization.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'UpdateDate' => [ + 'description' => 'The time when the role was updated.'."\n", + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.RoleName.InvalidChars', + 'errorMessage' => 'The specified role name contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidParameter.RoleName.Length', + 'errorMessage' => 'The maximum length of the role name is exceeded.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Role\\": {\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\",\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [ { \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"sts:AssumeRole\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"RAM\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"acs:ram::12345678901234****:root\\\\\\\\\\\\\\" } } ], \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\" }\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"IsServiceLinkedRole\\": true,\\n \\"LatestDeletionTask\\": {\\n \\"CreateDate\\": \\"2018-10-23T12:33:18Z\\",\\n \\"DeletionTaskId\\": \\"ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d\\"\\n },\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleId\\": \\"90123456789****\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"RolePrincipalName\\": \\"[email protected]\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetRoleResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n\\t<Role>\\r\\n\\t\\t<RoleId>90123456789****</RoleId>\\r\\n\\t\\t<RoleName>ECSAdmin</RoleName>\\r\\n\\t\\t<RolePrincipalName>[email protected]</RolePrincipalName>\\r\\n\\t\\t<Arn>acs:ram::123456789012****:role/ECSAdmin</Arn>\\r\\n\\t\\t<IsServiceLinkedRole>true</IsServiceLinkedRole>\\r\\n\\t\\t<LatestDeletionTask>\\r\\n\\t\\t\\t<CreateDate>2018-10-23T12:33:18Z</CreateDate>\\r\\n\\t\\t\\t<DeletionTaskId>ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d</DeletionTaskId>\\r\\n\\t\\t</LatestDeletionTask>\\r\\n\\t\\t<Description>ECS管理角色</Description>\\r\\n <MaxSessionDuration>3600</MaxSessionDuration>\\r\\n\\t\\t<AssumeRolePolicyDocument>{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }</AssumeRolePolicyDocument>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t<UpdateDate>2016-01-23T12:33:18Z</UpdateDate>\\r\\n\\t</Role>\\r\\n</GetRoleResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'GetRole', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRoles' => [ + 'summary' => 'Queries a list of RAM roles.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the descriptions of the RAM roles. Valid values:'."\n" + ."\n" + .'* en: English'."\n" + .'* zh-CN: Chinese'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => 'The information about the roles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the role.'."\n", + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'CreateDate' => [ + 'description' => 'The time when the role was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => 'The description of the role.'."\n", + 'type' => 'string', + 'example' => 'ECS administrator', + ], + 'IsServiceLinkedRole' => [ + 'description' => 'Indicates whether the role is a service-linked role.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LatestDeletionTask' => [ + 'description' => 'The information of the most recent deletion task.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the deletion task was created.'."\n", + 'type' => 'string', + 'example' => '2018-10-23T12:33:18Z', + ], + 'DeletionTaskId' => [ + 'description' => 'The ID of the deletion task.'."\n", + 'type' => 'string', + 'example' => 'ECSAdmin/cc61514b-26eb-4453-ab53-b142eb70****', + ], + ], + ], + 'MaxSessionDuration' => [ + 'description' => 'The maximum session duration of the role.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => 'The ID of the role.'."\n", + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => 'The name of the role.'."\n", + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => 'The name of the role after authorization.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'UpdateDate' => [ + 'description' => 'The time when the role was updated.'."\n", + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of roles.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"IsServiceLinkedRole\\": true,\\n \\"LatestDeletionTask\\": {\\n \\"CreateDate\\": \\"2018-10-23T12:33:18Z\\",\\n \\"DeletionTaskId\\": \\"ECSAdmin/cc61514b-26eb-4453-ab53-b142eb70****\\"\\n },\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleId\\": \\"90123456789****\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"RolePrincipalName\\": \\"[email protected]\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListRolesResponse>\\r\\n\\t<RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<Roles>\\r\\n\\t\\t<Role>\\r\\n\\t\\t\\t<RoleId>90123456789****</RoleId>\\r\\n\\t\\t\\t<RoleName>ECSAdmin</RoleName>\\r\\n\\t\\t\\t<RolePrincipalName>[email protected]</RolePrincipalName>\\r\\n\\t\\t\\t<Arn>acs:ram::123456789012****:role/ECSAdmin</Arn>\\r\\n\\t\\t\\t<IsServiceLinkedRole>true</IsServiceLinkedRole>\\r\\n\\t\\t\\t<LatestDeletionTask>\\r\\n\\t\\t\\t\\t<CreateDate>2018-10-23T12:33:18Z</CreateDate>\\r\\n\\t\\t\\t\\t<DeletionTaskId>ECSAdmin/cc61514b-26eb-4453-ab53-b142eb70****</DeletionTaskId>\\r\\n\\t\\t\\t</LatestDeletionTask>\\r\\n\\t\\t\\t<Description>ECS管理角色</Description>\\r\\n <MaxSessionDuration>3600</MaxSessionDuration>\\r\\n\\t\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t\\t<UpdateDate>2015-01-23T12:33:18Z</UpdateDate>\\r\\n\\t\\t</Role>\\r\\n\\t\\t<Role>\\r\\n\\t\\t\\t<RoleId>90123456789****</RoleId>\\r\\n\\t\\t\\t<RoleName>OSSReadonlyAccess</RoleName>\\r\\n\\t\\t\\t<RolePrincipalName>[email protected]</RolePrincipalName>\\r\\n\\t\\t\\t<Arn>acs:ram::123456789012****:role/OSSReadonlyAccess</Arn>\\r\\n\\t\\t\\t<Description>OSS只读访问角色</Description>\\r\\n <MaxSessionDuration>3600</MaxSessionDuration>\\r\\n\\t\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t\\t<UpdateDate>2015-01-23T12:33:18Z</UpdateDate>\\r\\n\\t\\t</Role>\\r\\n\\t</Roles>\\r\\n</ListRolesResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListRoles', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateServiceLinkedRole' => [ + 'summary' => 'Creates a service-linked role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service name.'."\n" + ."\n" + .'For more information about the service name, see [Alibaba Cloud services that support service-linked roles](~~461722~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'polardb.aliyuncs.com', + ], + ], + [ + 'name' => 'CustomSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The suffix of the role name.'."\n" + ."\n" + .'The role name (including its suffix) must be 1 to 64 characters in length and can contain letters, digits, periods (.), and hyphens (-).'."\n" + ."\n" + .'For example, if the suffix is `Example`, the role name is `ServiceLinkedRoleName_Example`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the service-linked role.'."\n" + ."\n" + .'You must configure this parameter for service-linked roles that support custom suffixes. Otherwise, the preset value is used and cannot be modified.'."\n" + ."\n" + .'The description must be 1 to 1,024 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FE58D7CF-03BC-432A-B42D-BC3390C8C2E1', + ], + 'Role' => [ + 'description' => 'The information about the role.'."\n", + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::177242285274****:role/aliyunserviceroleforpolardb', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => 'The document of the trust policy for the role.'."\n", + 'type' => 'string', + 'example' => '{\\"Statement\\":[{\\"Action\\":\\"sts:AssumeRole\\",\\"Effect\\":\\"Allow\\",\\"Principal\\":{\\"Service\\":[\\"polardb.aliyuncs.com\\"]}}],\\"Version\\":\\"1\\"}', + ], + 'CreateDate' => [ + 'description' => 'The time when the role was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T08:14:16Z', + ], + 'Description' => [ + 'description' => 'The description of the role.'."\n", + 'type' => 'string', + 'example' => 'Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.', + ], + 'IsServiceLinkedRole' => [ + 'description' => 'Indicates whether the role is a service-linked role. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RoleId' => [ + 'description' => 'The ID of the role.'."\n", + 'type' => 'string', + 'example' => '32833240981067****', + ], + 'RoleName' => [ + 'description' => 'The name of the role.'."\n", + 'type' => 'string', + 'example' => 'AliyunServiceRoleForPolarDB', + ], + 'RolePrincipalName' => [ + 'description' => 'The role name that uses a domain name as the suffix.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.CustomSuffix.NotAllowed', + 'errorMessage' => 'Custom suffix is not allowed for this Service Linked Role.', + ], + [ + 'errorCode' => 'InvalidParameter.CustomSuffix.InvalidChars', + 'errorMessage' => 'The parameter CustomSuffix contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidParameter.CustomSuffix.Length', + 'errorMessage' => 'The maximum length of the parameter CustomSuffix is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.Description.NotAllowed', + 'errorMessage' => 'Custom description is not allowed for default service linked role.', + ], + [ + 'errorCode' => 'InvalidParameter.Description.Length', + 'errorMessage' => 'The maximum length of the description is exceeded. It must not exceed 1024 characters.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Service', + 'errorMessage' => 'The service does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'EntityAlreadyExists.Role', + 'errorMessage' => 'The role already exists.', + ], + [ + 'errorCode' => 'LimitExceeded.Role', + 'errorMessage' => 'The maximum number of roles is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE58D7CF-03BC-432A-B42D-BC3390C8C2E1\\",\\n \\"Role\\": {\\n \\"Arn\\": \\"acs:ram::177242285274****:role/aliyunserviceroleforpolardb\\",\\n \\"AssumeRolePolicyDocument\\": \\"{\\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sts:AssumeRole\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Service\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"polardb.aliyuncs.com\\\\\\\\\\\\\\"]}}],\\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"CreateDate\\": \\"2020-06-30T08:14:16Z\\",\\n \\"Description\\": \\"Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.\\",\\n \\"IsServiceLinkedRole\\": true,\\n \\"RoleId\\": \\"32833240981067****\\",\\n \\"RoleName\\": \\"AliyunServiceRoleForPolarDB\\",\\n \\"RolePrincipalName\\": \\"[email protected]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceLinkedRoleResponse>\\n <Role>\\n <RoleName>AliyunServiceRoleForPolarDB</RoleName>\\n <Description>Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.</Description>\\n <AssumeRolePolicyDocument>{\\"Statement\\":[{\\"Action\\":\\"sts:AssumeRole\\",\\"Effect\\":\\"Allow\\",\\"Principal\\":{\\"Service\\":[\\"polardb.aliyuncs.com\\"]}}],\\"Version\\":\\"1\\"}</AssumeRolePolicyDocument>\\n <Arn>acs:ram::177242285274****:role/aliyunserviceroleforpolardb</Arn>\\n <IsServiceLinkedRole>true</IsServiceLinkedRole>\\n <CreateDate>2020-06-30T08:14:16Z</CreateDate>\\n <RoleId>32833240981067****</RoleId>\\n <RolePrincipalName>[email protected]</RolePrincipalName>\\n </Role>\\n <RequestId>FE58D7CF-03BC-432A-B42D-BC3390C8C2E1</RequestId>\\n</CreateServiceLinkedRoleResponse>","errorExample":""}]', + 'title' => 'CreateServiceLinkedRole', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteServiceLinkedRole' => [ + 'summary' => 'Deletes a service-linked role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the role.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunServiceRoleForPolarDB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeletionTaskId' => [ + 'description' => 'The ID of the deletion task.'."\n", + 'type' => 'string', + 'example' => 'task/acs-service-role/polardb.aliyuncs.com/AliyunServiceRoleForPolarDB/64c4f9cc-fac2-4692-ae1b-804ae4b9****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B595E5BF-FF5F-4E7F-B95A-B90FE242FEB6', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ServiceLinkedRole', + 'errorMessage' => 'This role exists but is not a Service Linked Role.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeletionTaskId\\": \\"task/acs-service-role/polardb.aliyuncs.com/AliyunServiceRoleForPolarDB/64c4f9cc-fac2-4692-ae1b-804ae4b9****\\",\\n \\"RequestId\\": \\"B595E5BF-FF5F-4E7F-B95A-B90FE242FEB6\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceLinkedRoleResponse>\\n <RequestId>B595E5BF-FF5F-4E7F-B95A-B90FE242FEB6</RequestId>\\n <DeletionTaskId>task/acs-service-role/polardb.aliyuncs.com/AliyunServiceRoleForPolarDB/64c4f9cc-fac2-4692-ae1b-804ae4b9****</DeletionTaskId>\\n</DeleteServiceLinkedRoleResponse>","errorExample":""}]', + 'title' => 'DeleteServiceLinkedRole', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetServiceLinkedRoleDeletionStatus' => [ + 'summary' => 'Queries the status of the task that is used to delete a service-linked role.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DeletionTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the deletion task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'task/acs-service-role/hdr.aliyuncs.com/AliyunServiceRoleForHdr/c4d22c52-247f-4ee1-83a2-6c0460bd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Reason' => [ + 'description' => 'The cause for the failure of the deletion task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The failure information.'."\n", + 'type' => 'string', + 'example' => 'Service-Linked Role acs:ram::196813227629****:role/aliyunserviceroleforhdr cannot be deleted as it is in use by hdr.aliyuncs.com.', + ], + 'RoleUsages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RoleUsage' => [ + 'description' => 'The information about the resources that the service-linked role can use.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resources that the service-linked role can use.'."\n", + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => 'global', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The information about resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about resources.'."\n", + 'type' => 'string', + 'example' => 'acs:hdr::196813227629****:sitepair/s-000h0y6kld0zwk8l****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '07194EB1-DB50-4513-A51D-99B30D635AEF', + ], + 'Status' => [ + 'description' => 'The status of the task.'."\n" + ."\n" + .'* SUCCEEDED'."\n" + .'* IN_PROGRESS'."\n" + .'* FAILED'."\n" + .'* NOT_STARTED'."\n" + .'* INTERNAL_ERROR'."\n", + 'type' => 'string', + 'example' => 'FAILED', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.DeletionTaskId', + 'errorMessage' => 'The DeletionTaskId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.DeletionTaskId.Length', + 'errorMessage' => 'The length of DeletionTaskId must be between 26 and 255 characters.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ServiceLinkedRole.DeletionTask', + 'errorMessage' => 'The deletion task for the given ID does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Reason\\": {\\n \\"Message\\": \\"Service-Linked Role acs:ram::196813227629****:role/aliyunserviceroleforhdr cannot be deleted as it is in use by hdr.aliyuncs.com.\\",\\n \\"RoleUsages\\": {\\n \\"RoleUsage\\": [\\n {\\n \\"Region\\": \\"global\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n \\"acs:hdr::196813227629****:sitepair/s-000h0y6kld0zwk8l****\\"\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"07194EB1-DB50-4513-A51D-99B30D635AEF\\",\\n \\"Status\\": \\"FAILED\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<GetServiceLinkedRoleDeletionStatusResponse>\\n <Status>FAILED</Status>\\n <RequestId>07194EB1-DB50-4513-A51D-99B30D635AEF</RequestId>\\n <Reason>\\n <Message>Service-Linked Role acs:ram::196813227629****:role/aliyunserviceroleforhdr cannot be deleted as it is in use by hdr.aliyuncs.com.</Message>\\n <RoleUsages>\\n <RoleUsage>\\n <Region>global</Region>\\n <Resources>\\n <Resource>acs:hdr::196813227629****:sitepair/s-000h0y6kld0zwk8l****</Resource>\\n </Resources>\\n </RoleUsage>\\n </RoleUsages>\\n </Reason>\\n</GetServiceLinkedRoleDeletionStatusResponse>","errorExample":""}]', + 'title' => 'GetServiceLinkedRoleDeletionStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePolicy' => [ + 'summary' => 'Creates a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the permission policy.'."\n" + ."\n" + .'The description must be 1 to 1,024 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS administrator', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'The document of the policy.'."\n" + ."\n" + .'The document must be 1 to 6,144 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => 'The information about the permission policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the permission policy was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DefaultVersion' => [ + 'description' => 'The version number of the permission policy. Default value: v1.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Description' => [ + 'description' => 'The description of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'OSS administrator', + ], + 'PolicyName' => [ + 'description' => 'The name of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'OSS-Administrator', + ], + 'PolicyType' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyDocument.Length', + 'errorMessage' => 'The maximum length of the policy document is exceeded. It must not exceed 6144 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.Description.Length', + 'errorMessage' => 'The maximum length of the description is exceeded. It must not exceed 1024 characters.', + ], + ], + 409 => [ + [ + 'errorCode' => 'MalformedPolicyDocument', + 'errorMessage' => 'The policy format is invalid.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.Policy', + 'errorMessage' => 'The policy already exists.', + ], + [ + 'errorCode' => 'LimitExceeded.Policy', + 'errorMessage' => 'The maximum number of policies is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Policy\\": {\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreatePolicyResponse>\\r\\n\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n\\t<Policy>\\r\\n\\t\\t<PolicyName>OSS-Administrator</PolicyName>\\r\\n\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t<Description>OSS管理员权限</Description>\\r\\n\\t\\t<DefaultVersion>v1</DefaultVersion>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t</Policy>\\r\\n</CreatePolicyResponse>","errorExample":""}]', + 'title' => 'CreatePolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePolicy' => [ + 'summary' => 'Deletes a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '898FAB24-7509-43EE-A287-086FE4C44394', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DeleteConflict.Policy.User', + 'errorMessage' => 'Before deleting the policy, it may not be attached to any user.', + ], + [ + 'errorCode' => 'DeleteConflict.Policy.Group', + 'errorMessage' => 'The policy cannot be attached to any group when you delete it.', + ], + [ + 'errorCode' => 'DeleteConflict.Policy.Version', + 'errorMessage' => 'You must delete all non-default versions before you delete the policy.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeletePolicyResponse>\\r\\n\\t<RequestId>898FAB24-7509-43EE-A287-086FE4C44394</RequestId>\\r\\n</DeletePolicyResponse>","errorExample":""}]', + 'title' => 'DeletePolicy', + 'description' => '> '."\n" + ."\n" + .'* Before you delete a permission policy, you must delete its all non-default versions. For information about how to delete a policy version, see [DeletePolicyVersion](~~159041~~).'."\n" + ."\n" + .'* Before you delete a permission policy, you must make sure that the policy is not attached to a RAM user, a RAM user group, or a RAM role. For information about how to detach a policy, see [DetachPolicy](~~159168~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetDefaultPolicyVersion' => [ + 'summary' => 'Sets a default version for a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + [ + 'errorCode' => 'InvalidParameter.VersionId.Format', + 'errorMessage' => 'The specified version ID is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.Policy.Version', + 'errorMessage' => 'The policy version does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<SetDefaultPolicyVersionResponse>\\r\\n\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</SetDefaultPolicyVersionResponse>","errorExample":""}]', + 'title' => 'SetDefaultPolicyVersion', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachPolicy' => [ + 'summary' => 'Attaches a permission policy to an object, which can be a RAM user, RAM user group, or RAM role. After you attach a permission policy to an object, the object has the operation permissions on the resources in a specific resource group or within a specific Alibaba Cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective scope of the permission policy. Valid values:'."\n" + ."\n" + .'* ID of a resource group: indicates that the permission policy takes effect for the resources in the resource group.'."\n" + .'* ID of the Alibaba Cloud account to which the authorized object belongs: indicates that the permission policy takes effect for the resources within the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'System', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AdministratorAccess', + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object to which you want to attach the permission policy. Valid values:'."\n" + ."\n" + .'* IMSUser: RAM user'."\n" + .'* IMSGroup: RAM user group'."\n" + .'* ServiceRole: RAM role'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'IMSUser', + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the object to which you want to attach the permission policy.'."\n" + ."\n" + .'* If you want to attach the permission policy to a RAM user, specify the name in the @.onaliyun.com format. indicates the name of the RAM user, and indicates the alias of the Alibaba Cloud account to which the RAM user belongs.'."\n" + .'* If you want to attach the permission policy to a RAM user group, specify the name in the @group..onaliyun.com format. indicates the name of the RAM user group, and indicates the alias of the Alibaba Cloud account to which the RAM user group belongs.'."\n" + .'* If you want to attach the permission policy to a RAM role, specify the name in the @role..onaliyunservice.com format. indicates the name of the RAM role, and indicates the alias of the Alibaba Cloud account to which the RAM role belongs.'."\n" + ."\n" + .'> The alias of an Alibaba Cloud account is a part of the default domain name. You can call the [GetDefaultDomain](~~186720~~) operation to obtain the alias of an Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '697852FB-50D7-44D9-9774-530C31EAC572', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyType', + 'errorMessage' => 'The specified policy type is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + ], + 409 => [ + [ + 'errorCode' => 'Invalid.ResourceGroup.Status', + 'errorMessage' => 'You cannot perform an operation on a resource group that is being created or deleted.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<AttachPolicyToUserResponse>\\r\\n\\t<RequestId>697852FB-50D7-44D9-9774-530C31EAC572</RequestId>\\r\\n</AttachPolicyToUserResponse>","errorExample":""}]', + 'title' => 'AttachPolicy', + 'description' => 'In this example, the policy `AdministratorAccess` is attached to the RAM user `[email protected]` and takes effect only for resources in the `rg-9gLOoK****` resource group.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachPolicy' => [ + 'summary' => 'Detaches a permission policy from an object. After you detach a policy from an object, the object does not have the operation permissions on the current resource group or the resources within the current account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs.'."\n" + ."\n" + .'This parameter specifies the resource group or Alibaba Cloud account for which you want to revoke permissions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object to which you want to attach the permission policy. Valid values:'."\n" + ."\n" + .'* IMSUser: RAM user'."\n" + .'* IMSGroup: RAM user group'."\n" + .'* ServiceRole: RAM role'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'IMSUser', + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the object to which you want to attach the permission policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '697852FB-50D7-44D9-9774-530C31EAC572', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyType', + 'errorMessage' => 'The specified policy type is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + ], + 409 => [ + [ + 'errorCode' => 'Invalid.ResourceGroup.Status', + 'errorMessage' => 'You cannot perform an operation on a resource group that is being created or deleted.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DetachPolicyFromUserResponse>\\r\\n\\t<RequestId>697852FB-50D7-44D9-9774-530C31EAC572</RequestId>\\r\\n</DetachPolicyFromUserResponse>","errorExample":""}]', + 'title' => 'DetachPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPolicies' => [ + 'summary' => 'Queries a list of permission policies.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. If you do not configure this parameter, all types of permission policies are returned. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the descriptions of the system permission policies. Valid values:'."\n" + ."\n" + .'* en: English.'."\n" + .'* zh-CN: Chinese'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Policies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Policy' => [ + 'description' => 'The information about the permission policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the permission policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'AttachmentCount' => [ + 'description' => 'The number of references to the permission policy.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateDate' => [ + 'description' => 'The time when the permission policy was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DefaultVersion' => [ + 'description' => 'The default version of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Description' => [ + 'description' => 'The description of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'OSS administrator', + ], + 'PolicyName' => [ + 'description' => 'The name of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'OSS-Administrator', + ], + 'PolicyType' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + 'UpdateDate' => [ + 'description' => 'The time when the permission policy was updated.'."\n", + 'type' => 'string', + 'example' => '2016-02-11T18:39:12Z', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"AttachmentCount\\": 1,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"UpdateDate\\": \\"2016-02-11T18:39:12Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<ListPoliciesResponse>\\n <RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>2</TotalCount>\\n <Policies>\\n <Policy>\\n <PolicyName>OSS-Administrator</PolicyName>\\n <PolicyType>Custom</PolicyType>\\n <Description>OSS管理员权限</Description>\\n <DefaultVersion>v1</DefaultVersion>\\n <CreateDate>2015-01-23T12:33:18Z</CreateDate>\\n <UpdateDate>2015-01-23T12:33:18Z</UpdateDate>\\n <AttachmentCount>1</AttachmentCount>\\n </Policy>\\n <Policy>\\n <PolicyName>ReadOnlyAccess</PolicyName>\\n <PolicyType>System</PolicyType>\\n <Description>只读权限</Description>\\n <DefaultVersion>v1</DefaultVersion>\\n <CreateDate>2015-02-11T18:39:12Z</CreateDate>\\n <UpdateDate>2015-02-11T18:39:12Z</UpdateDate>\\n <AttachmentCount>2</AttachmentCount>\\n </Policy>\\n </Policies>\\n</ListPoliciesResponse>","errorExample":""}]', + 'title' => 'ListPolicies', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPolicy' => [ + 'summary' => 'Queries the information about a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + 'enum' => [ + 'Custom', + 'System', + ], + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the description of the system permission policy. Valid values:'."\n" + ."\n" + .'* en: English'."\n" + .'* zh-CN: Chinese'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => 'The information about the permission policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'AttachmentCount' => [ + 'description' => 'The number of references to the permission policy.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateDate' => [ + 'description' => 'The time when the permission policy was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DefaultVersion' => [ + 'description' => 'The default version of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Description' => [ + 'description' => 'The description of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'OSS administrator', + ], + 'PolicyDocument' => [ + 'description' => 'The document of the permission policy.'."\n", + 'type' => 'string', + 'example' => ' { "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}', + ], + 'PolicyName' => [ + 'description' => 'The name of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'OSS-Administrator', + ], + 'PolicyType' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + 'UpdateDate' => [ + 'description' => 'The time when the permission policy was updated.'."\n", + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '697852FB-50D7-44D9-9774-530C31EAC572', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyType', + 'errorMessage' => 'The specified policy type is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Policy\\": {\\n \\"AttachmentCount\\": 0,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyDocument\\": \\" { \\\\\\"Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oss:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": [\\\\\\"acs:oss:*:*:*\\\\\\"]}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n },\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetPolicyResponse>\\r\\n\\t<RequestId>697852FB-50D7-44D9-9774-530C31EAC572</RequestId>\\r\\n\\t<Policy>\\r\\n\\t\\t<PolicyName>OSS-Administrator</PolicyName>\\r\\n\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t<Description>OSS管理员权限</Description>\\r\\n\\t\\t<DefaultVersion>v1</DefaultVersion>\\r\\n\\t\\t<PolicyDocument>{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}</PolicyDocument>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t<UpdateDate>2016-01-23T12:33:18Z</UpdateDate>\\r\\n\\t\\t<AttachmentCount>0</AttachmentCount>\\r\\n\\t</Policy>\\r\\n</GetPolicyResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'GetPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPolicyAttachments' => [ + 'summary' => 'Queries policy attachment records.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs. If you do not configure this parameter, the system lists all policy attachment records within the current account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-001', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. If you do not configure this parameter, all types of policies are returned. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'System', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AdministratorAccess', + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object to which you want to attach the permission policy. If you do not configure this parameter, the system lists all types of objects. Valid values:'."\n" + ."\n" + .'* IMSUser: RAM user'."\n" + .'* IMSGroup: RAM user group'."\n" + .'* ServiceRole: RAM role'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IMSUser', + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the object to which you want to attach the permission policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to return the description of the system policy. Valid values:'."\n" + ."\n" + .'* en: English'."\n" + .'* zh-CN: Chinese'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PolicyAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolicyAttachment' => [ + 'description' => 'The information about the permission policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the permission policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'AttachDate' => [ + 'description' => 'The time when the permission policy is attached.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => 'The description of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'The description of the policy.', + ], + 'PolicyName' => [ + 'description' => 'The name of the permission policy.'."\n", + 'type' => 'string', + 'example' => 'AdministratorAccess', + ], + 'PolicyType' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'example' => 'System', + ], + 'PrincipalName' => [ + 'description' => 'The name of the object to which the permission policy is attached.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'PrincipalType' => [ + 'description' => 'The type of the object to which the permission policy is attached. Valid values:'."\n" + ."\n" + .'* IMSUser: RAM user'."\n" + .'* IMSGroup: RAM user group'."\n" + .'* ServiceRole: RAM role'."\n", + 'type' => 'string', + 'example' => 'IMSUser', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyType', + 'errorMessage' => 'The specified policy type is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The specified resource group does not exist. You must first create a resource group.', + ], + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PolicyAttachments\\": {\\n \\"PolicyAttachment\\": [\\n {\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"管理员权限\\",\\n \\"PolicyName\\": \\"AdministratorAccess\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"PrincipalName\\": \\"[email protected]\\",\\n \\"PrincipalType\\": \\"IMSUser\\",\\n \\"ResourceGroupId\\": \\"rg-9gLOoK****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListPolicyAttachmentsResponse>\\r\\n\\t<RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<PolicyAttachments>\\r\\n\\t\\t<PolicyAttachment>\\r\\n\\t\\t\\t<ResourceGroupId>rg-9gLOoK****</ResourceGroupId>\\r\\n\\t\\t\\t<PolicyType>System</PolicyType>\\r\\n\\t\\t\\t<PolicyName>AdministratorAccess</PolicyName>\\r\\n\\t\\t\\t<PrincipalType>IMSUser</PrincipalType>\\r\\n\\t\\t\\t<PrincipalName>[email protected]</PrincipalName>\\r\\n\\t\\t\\t<AttachDate>2015-01-23T12:33:18Z</AttachDate>\\r\\n\\t\\t\\t<Description>管理员权限</Description>\\r\\n\\t\\t</PolicyAttachment>\\r\\n\\t\\t<PolicyAttachment>\\r\\n\\t\\t\\t<ResourceGroupId>12983255839348****</ResourceGroupId>\\r\\n\\t\\t\\t<PolicyType>Custom</PolicyType>\\r\\n\\t\\t\\t<PolicyName>OSS-Bucket1-Access</PolicyName>\\r\\n\\t\\t\\t<PrincipalType>ServiceRole</PrincipalType>\\r\\n\\t\\t\\t<PrincipalName>[email protected]</PrincipalName>\\r\\n\\t\\t\\t<AttachDate>2015-01-23T12:33:18Z</AttachDate>\\r\\n\\t\\t\\t<Description>OSS bucket 1的访问权限</Description>\\r\\n\\t\\t</PolicyAttachment>\\r\\n\\t</PolicyAttachments>\\r\\n</ListPolicyAttachmentsResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListPolicyAttachments', + 'description' => 'You can view the following information:'."\n" + ."\n" + .'* Policy attachment records within an Alibaba Cloud account or a resource group'."\n" + .'* Permission policies attached to RAM users, RAM user groups, or RAM roles'."\n" + .'* RAM users, RAM user groups, or RAM roles to which permission policies are attached within an Alibaba Cloud account or a resource group'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePolicyVersion' => [ + 'summary' => 'Creates a version for a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'The document of the permission policy.'."\n" + ."\n" + .'The document must be 1 to 6,144 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}', + ], + ], + [ + 'name' => 'SetAsDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to set the policy version as the default version.'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersion' => [ + 'description' => 'The information about the policy version.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the policy version was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18', + ], + 'IsDefaultVersion' => [ + 'description' => 'Indicates whether the policy version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'VersionId' => [ + 'description' => 'The ID of the policy version.'."\n", + 'type' => 'string', + 'example' => 'v3', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyDocument.Length', + 'errorMessage' => 'The maximum length of the policy document is exceeded. It must not exceed 6144 characters.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.Policy.Version', + 'errorMessage' => 'The maximum number of policy versions is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyVersion\\": {\\n \\"CreateDate\\": \\"2015-01-23T12:33:18\\",\\n \\"IsDefaultVersion\\": false,\\n \\"VersionId\\": \\"v3\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreatePolicyVersionResponse>\\r\\n\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n\\t<PolicyVersion>\\r\\n\\t\\t<VersionId>v3</VersionId>\\r\\n\\t\\t<IsDefaultVersion>false</IsDefaultVersion>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t</PolicyVersion>\\r\\n</CreatePolicyVersionResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'CreatePolicyVersion', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePolicyVersion' => [ + 'summary' => 'Deletes a version of a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy version.'."\n" + ."\n" + .'You can call the [ListPolicyVersions](~~159982~~) operation to query the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + [ + 'errorCode' => 'InvalidParameter.VersionId.Format', + 'errorMessage' => 'The specified version ID is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.Policy.Version', + 'errorMessage' => 'The policy version does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DeleteConflict.Policy.Version.Default', + 'errorMessage' => 'You cannot delete the default policy version.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeletePolicyVersionResponse>\\r\\n\\t\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</DeletePolicyVersionResponse>","errorExample":""}]', + 'title' => 'DeletePolicyVersion', + 'description' => '> The default version of a policy cannot be deleted.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPolicyVersions' => [ + 'summary' => 'Queries a list of versions of a policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolicyVersion' => [ + 'description' => 'The information about the policy version.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the policy version.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the policy version was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'IsDefaultVersion' => [ + 'description' => 'Indicates whether the policy version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'VersionId' => [ + 'description' => 'The ID of the policy version.'."\n", + 'type' => 'string', + 'example' => 'v3', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyType', + 'errorMessage' => 'The specified policy type is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 64 characters in length.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyVersions\\": {\\n \\"PolicyVersion\\": [\\n {\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"IsDefaultVersion\\": false,\\n \\"VersionId\\": \\"v3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListPolicyVersionsResponse>\\r\\n\\t<RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>\\r\\n\\t<PolicyVersions>\\r\\n\\t\\t<PolicyVersion>\\r\\n\\t\\t\\t<VersionId>v3</VersionId>\\r\\n\\t\\t\\t<IsDefaultVersion>false</IsDefaultVersion>\\r\\n\\t\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t</PolicyVersion>\\r\\n\\t\\t<PolicyVersion>\\r\\n\\t\\t\\t<VersionId>v5</VersionId>\\r\\n\\t\\t\\t<IsDefaultVersion>true</IsDefaultVersion>\\r\\n\\t\\t\\t<CreateDate>2015-02-26T01:25:52Z</CreateDate>\\r\\n\\t\\t</PolicyVersion>\\r\\n\\t</PolicyVersions>\\r\\n</ListPolicyVersionsResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListPolicyVersions', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPolicyVersion' => [ + 'summary' => 'Queries the information about a version of a permission policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the permission policy. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + 'enum' => [ + 'Custom', + 'System', + ], + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersion' => [ + 'description' => 'The information about the policy version.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => 'The time when the policy version was created.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'IsDefaultVersion' => [ + 'description' => 'Indicates whether the policy version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'PolicyDocument' => [ + 'description' => 'The document of the permission policy.'."\n", + 'type' => 'string', + 'example' => '{ \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}', + ], + 'VersionId' => [ + 'description' => 'The ID of the policy version.'."\n", + 'type' => 'string', + 'example' => 'v3', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PolicyType', + 'errorMessage' => 'The specified policy type is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.InvalidChars', + 'errorMessage' => 'The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).', + ], + [ + 'errorCode' => 'InvalidParameter.PolicyName.Length', + 'errorMessage' => 'The length of the policy name is invalid. It must be 1 to 128 characters in length.', + ], + [ + 'errorCode' => 'InvalidParameter.VersionId.Format', + 'errorMessage' => 'The specified version ID is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.Policy', + 'errorMessage' => 'The policy does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.Policy.Version', + 'errorMessage' => 'The policy version does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyVersion\\": {\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"IsDefaultVersion\\": false,\\n \\"PolicyDocument\\": \\"{ \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [{ \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": [\\\\\\\\\\\\\\"oss:*\\\\\\\\\\\\\\"], \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Resource\\\\\\\\\\\\\\": [\\\\\\\\\\\\\\"acs:oss:*:*:*\\\\\\\\\\\\\\"]}], \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"VersionId\\": \\"v3\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<GetPolicyVersionResponse>\\r\\n\\t<RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n\\t<PolicyVersion>\\r\\n\\t\\t<VersionId>v3</VersionId>\\r\\n\\t\\t<IsDefaultVersion>false</IsDefaultVersion>\\r\\n\\t\\t<CreateDate>2015-01-23T12:33:18Z</CreateDate>\\r\\n\\t\\t<PolicyDocument>{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}</PolicyDocument>\\r\\n\\t</PolicyVersion>\\r\\n</GetPolicyVersionResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'GetPolicyVersion', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to resource groups or the members in a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The ID of a resource group or member.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource group or member.'."\n" + ."\n" + .'You can specify a maximum of 50 IDs.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz6bre2uq****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n" + ."\n" + .'A tag key can be a maximum of 128 characters in length. It cannot contain `http://` or `https://` and cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n" + ."\n" + .'A tag value can be a maximum of 128 characters in length. It cannot contain `http://` or `https://` and cannot start with `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the objects to which you want to add tags. Valid values:'."\n" + ."\n" + .'* ResourceGroup : resource group. This is the default value.'."\n" + .'* Account: member.'."\n" + ."\n" + .'> This parameter is required if you add tags to members in a resource directory.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + 'description' => 'This topic provides an example on how to call the API operation to add the tag `k1:v1` to the resource group with an ID of `rg-aekz6bre2uq****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from resource groups or the members in a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags from the specified resource groups or members. Valid values:'."\n" + ."\n" + .'* false (default value)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The ID of a resource group or member.'."\n" + ."\n" + .'You can specify a maximum of 50 IDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource group or member.'."\n" + ."\n" + .'You can specify a maximum of 50 IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2dpwyrfr****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'A tag key.'."\n" + ."\n" + .'You can specify a maximum of 20 tag keys.'."\n" + ."\n" + .'> If you set the `All` parameter to `true`, you do not need to configure this parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag key.'."\n" + ."\n" + .'You can specify a maximum of 20 tag keys.'."\n" + ."\n" + .'> If you set the `All` parameter to `true`, you do not need to configure this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the objects from which you want to remove tags. Valid values:'."\n" + ."\n" + .'* ResourceGroup: resource group. This is the default value.'."\n" + .'* Account: member.'."\n" + ."\n" + .'> This parameter is required if you remove tags from members in a resource directory.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + 'description' => 'This topic provides an example on how to call the API operation to remove the tag whose tag key is `k1` from the resource group whose ID is `rg-aek2dpwyrfr****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to resource groups or the members in a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The 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' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tag key and value.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key and value.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'A tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'A tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource ID.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource group or member. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'> If you want to query the tags that are added to the members in a resource directory, you must configure both the `ResourceId.N` and `ResourceType` parameters and set the `ResourceType` parameter to `Account` in your request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz6bre2uq****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the objects whose tags you want to query. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* ResourceGroup: resource group. This is the default value.'."\n" + .'* Account: member.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8054B059-6B36-53BF-AA45-B8C9A0ED05AB', + ], + 'TagResources' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The ID of the resource group or member.'."\n", + 'type' => 'string', + 'example' => 'rg-aekz6bre2uq****', + ], + 'ResourceType' => [ + 'description' => 'The type of the object whose tags are queried. Valid values:'."\n" + ."\n" + .'* resourcegroup: resource group'."\n" + .'* Account: member'."\n", + 'type' => 'string', + 'example' => 'resourcegroup', + ], + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"8054B059-6B36-53BF-AA45-B8C9A0ED05AB\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"rg-aekz6bre2uq****\\",\\n \\"ResourceType\\": \\"resourcegroup\\",\\n \\"TagKey\\": \\"k1\\",\\n \\"TagValue\\": \\"k1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <RequestId>8054B059-6B36-53BF-AA45-B8C9A0ED05AB</RequestId>\\n <TagResources>\\n <ResourceId>rg-aekz6bre2uq****</ResourceId>\\n <TagKey>k1</TagKey>\\n <ResourceType>resourcegroup</ResourceType>\\n <TagValue>v1</TagValue>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + 'description' => 'This topic provides an example on how to call the API operation to query the tags that are added to the resource group with an ID of `rg-aekz6bre2uq****`. The response shows that only the `k1:v1` tag is added to the resource group.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'ListTagKeys' => [ + 'summary' => 'Queries tag keys.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'The value Account indicates the members of the resource directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Account', + ], + ], + [ + 'name' => 'KeyFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key for a fuzzy query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'team', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC09A6AA-2713-4E10-A2E9-E6C5C43A8842', + ], + 'Tags' => [ + 'description' => 'The information of the tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'team', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"DC09A6AA-2713-4E10-A2E9-E6C5C43A8842\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"team\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagKeysResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <RequestId>DC09A6AA-2713-4E10-A2E9-E6C5C43A8842</RequestId>\\n <Tags>\\n <Key>team</Key>\\n </Tags>\\n</ListTagKeysResponse>","errorExample":""}]', + 'title' => 'ListTagKeys', + 'description' => 'This topic provides an example on how to call the API operation to query tag keys. The response shows that the custom tag key team exists.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'ListTagValues' => [ + 'summary' => 'Queries the tag values of a tag key.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'The value Account indicates the members of the resource directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Account', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'k1', + ], + ], + [ + 'name' => 'ValueFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag value for a fuzzy query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC09A6AA-2713-4E10-A2E9-E6C5C43A8842', + ], + 'Tags' => [ + 'description' => 'The information of the tag values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"DC09A6AA-2713-4E10-A2E9-E6C5C43A8842\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"v1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagValuesResponse>\\n <NextToken>TGlzdFJlc291cm****</NextToken>\\n <RequestId>DC09A6AA-2713-4E10-A2E9-E6C5C43A8842</RequestId>\\n <Tags>\\n <Value>v1</Value>\\n </Tags>\\n</ListTagValuesResponse>","errorExample":""}]', + 'title' => 'ListTagValues', + 'description' => 'This topic provides an example on how to call the API operation to query the tag values of the tag key k1. The response shows that the tag value of the tag key k1 is v1.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'InitResourceDirectory' => [ + 'summary' => 'Enables a resource directory. After you enable a resource directory, the system automatically creates a root folder and sets the current account as the enterprise management account of the resource directory. The enterprise management account has all administrative permissions on this resource direc', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CD76D376-2517-4924-92C5-DBC52262F93A', + ], + 'ResourceDirectory' => [ + 'description' => 'The information of the resource directory.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'The time when the resource directory was enabled.'."\n", + 'type' => 'string', + 'example' => '2019-02-18T15:32:10.473Z', + ], + 'MasterAccountId' => [ + 'description' => 'The ID of the enterprise management account.'."\n", + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => 'The name of the enterprise management account.'."\n", + 'type' => 'string', + 'example' => 'aliyun-****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-Ss****', + ], + 'RootFolderId' => [ + 'description' => 'The ID of the root folder.'."\n", + 'type' => 'string', + 'example' => 'r-Zo****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'NotSupport.AccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified account is an Alibaba Cloud account or already exists in another resource directory.', + ], + [ + 'errorCode' => 'EnterpriseRealNameVerificationError', + 'errorMessage' => 'The specified account does not pass enterprise real-name verification. We recommend you first complete enterprise real-name verification for the account.', + ], + [ + 'errorCode' => 'Invalid.AccountType', + 'errorMessage' => 'The specified profile type of account is invalid.', + ], + [ + 'errorCode' => 'Invalid.EnterpriseName', + 'errorMessage' => 'You must specify the enterprise name.', + ], + [ + 'errorCode' => 'NotSupport.Account.Site', + 'errorMessage' => 'The caller is not a China site account, which is not supported.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD76D376-2517-4924-92C5-DBC52262F93A\\",\\n \\"ResourceDirectory\\": {\\n \\"CreateTime\\": \\"2019-02-18T15:32:10.473Z\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"MasterAccountName\\": \\"aliyun-****\\",\\n \\"ResourceDirectoryId\\": \\"rd-Ss****\\",\\n \\"RootFolderId\\": \\"r-Zo****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<InitResourceDirectoryResponse>\\r\\n <ResourceDirectory>\\r\\n <RootFolderId>r-Zo****</RootFolderId>\\r\\n <ResourceDirectoryId>rd-Ss****</ResourceDirectoryId>\\r\\n <MasterAccountId>172841235500****</MasterAccountId>\\r\\n <MasterAccountName>aliyun-****</MasterAccountName>\\r\\n <CreateTime>2019-02-18T15:32:10.473Z</CreateTime>\\r\\n </ResourceDirectory>\\r\\n <RequestId>CD76D376-2517-4924-92C5-DBC52262F93A</RequestId>\\r\\n</InitResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'InitResourceDirectory', + 'description' => '> '."\n" + .'* An account can be used to enable a resource directory only after it passes enterprise real-name verification. An account that only passed individual real-name verification cannot be used to enable a resource directory.'."\n" + .'* We recommend that you only use the enterprise management account as the administrator of the resource directory. Do not use the enterprise management account to purchase cloud resources.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCloudAccount' => [ + 'summary' => 'Creates a cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the member account.'."\n" + ."\n" + .'The name must be 2 to 50 characters in length and can contain letters, digits, underscores (\\_), periods (.), and hyphens (-).'."\n" + ."\n" + .'The name must be unique in the current resource directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'admin-****', + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent folder.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fd-bVaRIG****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address used to log on to the cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'PayerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the settlement account. If you do not specify this parameter, the current account is used for settlement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12323344****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the member account.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the member account.'."\n", + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => 'The name of the member account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member account.'."\n", + 'type' => 'string', + 'example' => 'admin-****', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member account joined the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member account is invited to join the resource directory.'."\n" + .'* created: The member account is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member account was modified.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => 'The status of the member account. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member account is created.'."\n" + .'* CreateVerifying: The creation of the member account is under confirmation.'."\n" + .'* CreateFailed: The member account failed to be created.'."\n" + .'* CreateExpired: The creation of the member account expired.'."\n" + .'* CreateCancelled: The creation of the member account is canceled.'."\n" + .'* PromoteVerifying: The upgrade of the member account is under confirmation.'."\n" + .'* PromoteFailed: The member account failed to be upgraded.'."\n" + .'* PromoteExpired: The upgrade of the member account expired.'."\n" + .'* PromoteCancelled: The upgrade of the member account is canceled.'."\n" + .'* PromoteSuccess: The member account is upgraded.'."\n" + .'* InviteSuccess: The owner of the member account accepted the invitation.'."\n" + .'* Removed: The member account is removed from the resource directory.'."\n", + 'type' => 'string', + 'example' => 'CreateVerifying', + ], + 'Type' => [ + 'description' => 'The type of the member account. The value CloudAccount indicates that the member account is a cloud account.'."\n", + 'type' => 'string', + 'example' => 'CloudAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.Account.DisplayName', + 'errorMessage' => 'You must specify DisplayName.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName', + 'errorMessage' => 'The DisplayName of account is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName.Length', + 'errorMessage' => 'The DisplayName of the account exceeds the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ParentFolderId', + 'errorMessage' => 'The ParentFolderId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.Email', + 'errorMessage' => 'You must specify Email.', + ], + [ + 'errorCode' => 'InvalidParameter.Email', + 'errorMessage' => 'The Email is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.Folder', + 'errorMessage' => 'The resource directory folder does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'LimitExceeded.Account', + 'errorMessage' => 'The maximum number of member accounts in a resource directory exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter.Account.DisplayName.AlreadyUsed', + 'errorMessage' => 'The displayname of account has been used.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceDirectory.Account', + 'errorMessage' => 'The email address that the system generates when you create a member account already exists. Try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Email.AlreadyUsed', + 'errorMessage' => 'The email has been used.', + ], + [ + 'errorCode' => 'Invalid.PayRelation', + 'errorMessage' => 'Failed to create a member. The specified billing account is unavailable. Please change to another billing account and try again.', + ], + [ + 'errorCode' => 'NotSupport.PayerAccountInAnotherResourceDirectory', + 'errorMessage' => 'The specified settlement account does not exist in the resource directory. You must specify a valid settlement account.', + ], + [ + 'errorCode' => 'CreateAccountDisabled', + 'errorMessage' => 'This resource directory is denied to create account.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseVerifyError', + 'errorMessage' => 'The type of the payment account is not enterprise verified.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipVerifyError', + 'errorMessage' => 'The payment account must not be the beneficiary account from other financial relationships.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseTypeError', + 'errorMessage' => 'The type of the payment account is not enterprise.', + ], + [ + 'errorCode' => 'PaymentAccountFinancialRelationshipsChangeFrequencyVerifyError', + 'errorMessage' => 'The financial relationship of payment account changes too frequently. Please try again later.', + ], + [ + 'errorCode' => 'MemberAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the member account must not be virtual operator.', + ], + [ + 'errorCode' => 'MemberAccountResellerVerifyError', + 'errorMessage' => 'The type of the member account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountVirtualCloudOperatorVerifyError', + 'errorMessage' => 'The type of the payment account must not be virtual operator.', + ], + [ + 'errorCode' => 'PaymentAccountResellerVerifyError', + 'errorMessage' => 'The type of the payment account must not be reseller.', + ], + [ + 'errorCode' => 'PaymentAccountCreditIdentityTypeError', + 'errorMessage' => 'The identity of the payment account is not credit.', + ], + [ + 'errorCode' => 'InconsistentEnterpriseNameError', + 'errorMessage' => 'The enterprise name of the payment account and the member account must be consistent.', + ], + [ + 'errorCode' => 'PaymentAccountEnterpriseInvoiceError', + 'errorMessage' => 'No enterprise invoice header information is set for the payment account.', + ], + [ + 'errorCode' => 'UnknownFinancialError', + 'errorMessage' => 'An unknown financial error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"AccountId\\": \\"12323344****\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"DisplayName\\": \\"admin-****\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RecordId\\": \\"06950264-3f0d-4ca9-82dd-6ee7a3d3****\\",\\n \\"ResourceDirectoryId\\": \\"rd-k3****\\",\\n \\"Status\\": \\"CreateVerifying\\",\\n \\"Type\\": \\"CloudAccount\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateCloudAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n <Account>\\r\\n <ResourceDirectoryId>rd-k3****</ResourceDirectoryId>\\r\\n <AccountId>12323344****</AccountId>\\r\\n <AccountName>[email protected]</AccountName>\\r\\n <DisplayName>admin-****</DisplayName>\\r\\n <FolderId>fd-bVaRIG****</FolderId>\\r\\n <JoinMethod>created</JoinMethod>\\r\\n <Type>CloudAccount</Type>\\r\\n <Status>CreateVerifying</Status>\\r\\n <RecordId>06950264-3f0d-4ca9-82dd-6ee7a3d3****</RecordId>\\r\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\r\\n </Account>\\r\\n</CreateCloudAccountResponse>","errorExample":""}]', + 'title' => 'CreateCloudAccount', + 'description' => 'A resource directory supports two types of member accounts: resource accounts and cloud accounts.'."\n" + ."\n" + .'* Resource account (recommended): A resource account is only used as a resource container and fully depends on a resource directory. Such member accounts are secure and easy-to-create. For more information about how to create a resource account, see [CreateResourceAccount](~~159392~~).'."\n" + ."\n" + .'> A resource account can be upgraded to a cloud account. For more information, see [PromoteResourceAccount](~~159395~~) .'."\n" + ."\n" + .'* Cloud account: A cloud account has all the features of an Alibaba Cloud account, including root permissions.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PromoteResourceAccount' => [ + 'summary' => 'Upgrades a resource account to a cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource account you want to upgrade.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12323344****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address used to log on to the cloud account after the upgrade.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the member account.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the member account.'."\n", + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => 'The name of the member account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member account.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member account joined the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member account is invited to join the resource directory.'."\n" + .'* created: The member account is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'JoinTime' => [ + 'description' => 'The time when the member account joined the resource directory.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member account was modified.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => 'The status of the member account. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member account is created.'."\n" + .'* CreateVerifying: The creation of the member account is under confirmation.'."\n" + .'* CreateFailed: The member account failed to be created.'."\n" + .'* CreateExpired: The creation of the member account expired.'."\n" + .'* CreateCancelled: The creation of the member account is canceled.'."\n" + .'* PromoteVerifying: The upgrade of the member account is under confirmation.'."\n" + .'* PromoteFailed: The member account failed to be upgraded.'."\n" + .'* PromoteExpired: The upgrade of the member account expired.'."\n" + .'* PromoteCancelled: The upgrade of the member account is canceled.'."\n" + .'* PromoteSuccess: The member account is upgraded.'."\n" + .'* InviteSuccess: The owner of the member account accepted the invitation.'."\n" + .'* Removed: The member account is removed from the resource directory.'."\n", + 'type' => 'string', + 'example' => 'PromoteVerifying', + ], + 'Type' => [ + 'description' => 'The type of the member account. Valid values:'."\n" + ."\n" + .'* CloudAccount'."\n" + .'* ResourceAccount'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AccountId', + 'errorMessage' => 'You must specify AccountId.', + ], + [ + 'errorCode' => 'InvalidParameter.AccountId', + 'errorMessage' => 'The AccountId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.Email', + 'errorMessage' => 'You must specify Email.', + ], + [ + 'errorCode' => 'InvalidParameter.Email', + 'errorMessage' => 'The Email is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Account', + 'errorMessage' => 'This resource directory account does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + [ + 'errorCode' => 'InvalidParameter.Email.AlreadyUsed', + 'errorMessage' => 'The email has been used.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"AccountId\\": \\"12323344****\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"DisplayName\\": \\"admin\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"JoinTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RecordId\\": \\"06950264-3f0d-4ca9-82dd-6ee7a3d33d6b\\",\\n \\"ResourceDirectoryId\\": \\"rd-k3****\\",\\n \\"Status\\": \\"PromoteVerifying\\",\\n \\"Type\\": \\"ResourceAccount\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<PromoteResourceAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n <Account>\\r\\n <ResourceDirectoryId>rd-k3****</ResourceDirectoryId>\\r\\n <AccountId>12323344****</AccountId>\\r\\n <DisplayName>admin</DisplayName>\\r\\n <FolderId>fd-bVaRIG****</FolderId>\\r\\n <JoinMethod>created</JoinMethod>\\r\\n <JoinTime>2015-01-23T12:33:18Z</JoinTime>\\r\\n <Type>ResourceAccount</Type>\\r\\n <Status>PromoteVerifying</Status>\\r\\n <RecordId>06950264-3f0d-4ca9-82dd-6ee7a3d33d6b</RecordId>\\r\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\r\\n </Account>\\r\\n</PromoteResourceAccountResponse>","errorExample":""}]', + 'title' => 'PromoteResourceAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResendPromoteResourceAccountEmail' => [ + 'summary' => 'Resends an email that is used to confirm the upgrade from a resource account to a cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the member account.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member account.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member account joined the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member account is invited to join the resource directory.'."\n" + .'* created: The member account is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'JoinTime' => [ + 'description' => 'The time when the member account joined the resource directory.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member account was modified.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'example' => '16950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => 'The status of the member account. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member account is created.'."\n" + .'* CreateVerifying: The creation of the member account is under confirmation.'."\n" + .'* CreateFailed: The member account failed to be created.'."\n" + .'* CreateExpired: The creation of the member account expired.'."\n" + .'* CreateCancelled: The creation of the member account is canceled.'."\n" + .'* PromoteVerifying: The upgrade of the member account is under confirmation.'."\n" + .'* PromoteFailed: The member account failed to be upgraded.'."\n" + .'* PromoteExpired: The upgrade of the member account expired.'."\n" + .'* PromoteCancelled: The upgrade of the member account is canceled.'."\n" + .'* PromoteSuccess: The member account is upgraded.'."\n" + .'* InviteSuccess: The owner of the member account accepted the invitation.'."\n" + .'* Removed: The member account is removed from the resource directory.'."\n", + 'type' => 'string', + 'example' => 'PromoteVerifying', + ], + 'Type' => [ + 'description' => 'The type of the member account. Valid values:'."\n" + ."\n" + .'* CloudAccount: cloud account'."\n" + .'* ResourceAccount: resource account'."\n", + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.RecordId', + 'errorMessage' => 'You must specify RecordId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.AccountRecord', + 'errorMessage' => 'This resource directory account recordId does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + [ + 'errorCode' => 'LimitExceeded.Frequency', + 'errorMessage' => 'The frequency of request exceeds limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"AccountId\\": \\"12323344****\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"DisplayName\\": \\"admin\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"JoinTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RecordId\\": \\"16950264-3f0d-4ca9-82dd-6ee7a3d3****\\",\\n \\"ResourceDirectoryId\\": \\"rd-k3****\\",\\n \\"Status\\": \\"PromoteVerifying\\",\\n \\"Type\\": \\"ResourceAccount\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ResendPromoteResourceAccountEmailResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n <Account>\\r\\n <ResourceDirectoryId>rd-k3****</ResourceDirectoryId>\\r\\n <AccountId>12323344****</AccountId>\\r\\n <DisplayName>admin</DisplayName>\\r\\n <FolderId>fd-bVaRIG****</FolderId>\\r\\n <JoinMethod>created</JoinMethod>\\r\\n <JoinTime>2015-01-23T12:33:18Z</JoinTime>\\r\\n <Type>ResourceAccount</Type>\\r\\n <Status>PromoteVerifying</Status>\\r\\n <RecordId>16950264-3f0d-4ca9-82dd-6ee7a3d33d6b</RecordId>\\r\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\r\\n </Account>\\r\\n</ResendPromoteResourceAccountEmailResponse>","errorExample":""}]', + 'title' => 'ResendPromoteResourceAccountEmail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResendCreateCloudAccountEmail' => [ + 'summary' => 'Resends an email that is used to confirm the creation of a cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The information of the member account.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'DisplayName' => [ + 'description' => 'The display name of the member account.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => 'The ID of the folder.'."\n", + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => 'The way in which the member account joined the resource directory. Valid values:'."\n" + ."\n" + .'* invited: The member account is invited to join the resource directory.'."\n" + .'* created: The member account is directly created in the resource directory.'."\n", + 'type' => 'string', + 'example' => 'created', + ], + 'JoinTime' => [ + 'description' => 'The time when the member account joined the resource directory.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member account was modified.'."\n", + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'example' => '16950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + 'ResourceDirectoryId' => [ + 'description' => 'The ID of the resource directory.'."\n", + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => 'The status of the member account. Valid values:'."\n" + ."\n" + .'* CreateSuccess: The member account is created.'."\n" + .'* CreateVerifying: The creation of the member account is under confirmation.'."\n" + .'* CreateFailed: The member account failed to be created.'."\n" + .'* CreateExpired: The creation of the member account expired.'."\n" + .'* CreateCancelled: The creation of the member account is canceled.'."\n" + .'* PromoteVerifying: The upgrade of the member account is under confirmation.'."\n" + .'* PromoteFailed: The member account failed to be upgraded.'."\n" + .'* PromoteExpired: The upgrade of the member account expired.'."\n" + .'* PromoteCancelled: The upgrade of the member account is canceled.'."\n" + .'* PromoteSuccess: The member account is upgraded.'."\n" + .'* InviteSuccess: The owner of the member account accepted the invitation.'."\n" + .'* Removed: The member account is removed from the resource directory.'."\n", + 'type' => 'string', + 'example' => 'CreateVerifying', + ], + 'Type' => [ + 'description' => 'The type of the member account. The value CloudAccount indicates that the member account is a cloud account.'."\n", + 'type' => 'string', + 'example' => 'CloudAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.RecordId', + 'errorMessage' => 'You must specify RecordId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + [ + 'errorCode' => 'EntityNotExists.AccountRecord', + 'errorMessage' => 'This resource directory account recordId does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + [ + 'errorCode' => 'LimitExceeded.Frequency', + 'errorMessage' => 'The frequency of request exceeds limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Account\\": {\\n \\"AccountId\\": \\"12323344****\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"DisplayName\\": \\"admin\\",\\n \\"FolderId\\": \\"fd-bVaRIG****\\",\\n \\"JoinMethod\\": \\"created\\",\\n \\"JoinTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"ModifyTime\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RecordId\\": \\"16950264-3f0d-4ca9-82dd-6ee7a3d3****\\",\\n \\"ResourceDirectoryId\\": \\"rd-k3****\\",\\n \\"Status\\": \\"CreateVerifying\\",\\n \\"Type\\": \\"CloudAccount\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ResendCreateCloudAccountEmailResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n <Account>\\r\\n <ResourceDirectoryId>rd-k3****</ResourceDirectoryId>\\r\\n <AccountId>12323344****</AccountId>\\r\\n <DisplayName>admin</DisplayName>\\r\\n <FolderId>fd-bVaRIG****</FolderId>\\r\\n <JoinMethod>created</JoinMethod>\\r\\n <JoinTime>2015-01-23T12:33:18Z</JoinTime>\\r\\n <Type>CloudAccount</Type>\\r\\n <Status>CreateVerifying</Status>\\r\\n <RecordId>16950264-3f0d-4ca9-82dd-6ee7a3d33d6b</RecordId>\\r\\n <ModifyTime>2015-01-23T12:33:18Z</ModifyTime>\\r\\n </Account>\\r\\n</ResendCreateCloudAccountEmailResponse>","errorExample":""}]', + 'title' => 'ResendCreateCloudAccountEmail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelCreateCloudAccount' => [ + 'summary' => 'Cancels the creation of a cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.RecordId', + 'errorMessage' => 'You must specify RecordId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AccountRecord', + 'errorMessage' => 'This resource directory account recordId does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CancelCreateCloudAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</CancelCreateCloudAccountResponse>","errorExample":""}]', + 'title' => 'CancelCreateCloudAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelPromoteResourceAccount' => [ + 'summary' => 'Cancels the upgrade from a resource account to a cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account record ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.RecordId', + 'errorMessage' => 'You must specify RecordId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.AccountRecord', + 'errorMessage' => 'This resource directory account recordId does not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceDirectory', + 'errorMessage' => 'The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountTypeOrStatusMismatch', + 'errorMessage' => 'You cannot perform the action on the member account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CancelPromoteResourceAccountResponse>\\r\\n <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>\\r\\n</CancelPromoteResourceAccountResponse>","errorExample":""}]', + 'title' => 'CancelPromoteResourceAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'resourcemanager.aliyuncs.com', + ], + ], +]; |
