From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/resourcemanager/2020-03-31/api-docs.php | 15845 +++++++++++++++++++ 1 file changed, 15845 insertions(+) create mode 100644 data/zh_cn/resourcemanager/2020-03-31/api-docs.php (limited to 'data/zh_cn/resourcemanager/2020-03-31') diff --git a/data/zh_cn/resourcemanager/2020-03-31/api-docs.php b/data/zh_cn/resourcemanager/2020-03-31/api-docs.php new file mode 100644 index 0000000..a76c365 --- /dev/null +++ b/data/zh_cn/resourcemanager/2020-03-31/api-docs.php @@ -0,0 +1,15845 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ResourceManager', + 'version' => '2020-03-31', + ], + 'directories' => [ + [ + 'id' => 142920, + 'title' => '资源目录', + 'type' => 'directory', + 'children' => [ + 'EnableResourceDirectory', + 'SendVerificationCodeForEnableRD', + 'GetResourceDirectory', + 'DestroyResourceDirectory', + ], + ], + [ + 'id' => 190386, + 'title' => '资源夹', + 'type' => 'directory', + 'children' => [ + 'CreateFolder', + 'GetFolder', + 'UpdateFolder', + 'DeleteFolder', + 'ListFoldersForParent', + 'ListAncestors', + ], + ], + [ + 'id' => 190387, + 'title' => '成员', + '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' => '管控策略', + 'type' => 'directory', + 'children' => [ + 'EnableControlPolicy', + 'GetControlPolicyEnablementStatus', + 'DisableControlPolicy', + 'CreateControlPolicy', + 'GetControlPolicy', + 'UpdateControlPolicy', + 'DeleteControlPolicy', + 'AttachControlPolicy', + 'DetachControlPolicy', + 'ListControlPolicies', + 'ListControlPolicyAttachmentsForTarget', + 'ListTargetAttachmentsForControlPolicy', + ], + ], + [ + 'id' => 190388, + 'title' => '可信服务', + 'type' => 'directory', + 'children' => [ + 'ListTrustedServiceStatus', + 'RegisterDelegatedAdministrator', + 'DeregisterDelegatedAdministrator', + 'ListDelegatedAdministrators', + 'ListDelegatedServicesForAccount', + ], + ], + [ + 'id' => 142982, + 'title' => '资源组', + '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' => '角色', + 'type' => 'directory', + 'children' => [ + 'CreateRole', + 'DeleteRole', + 'UpdateRole', + 'GetRole', + 'ListRoles', + ], + ], + [ + 'id' => 142958, + 'title' => '服务关联角色', + 'type' => 'directory', + 'children' => [ + 'CreateServiceLinkedRole', + 'DeleteServiceLinkedRole', + 'GetServiceLinkedRoleDeletionStatus', + ], + ], + [ + 'id' => 142962, + 'title' => '权限策略', + 'type' => 'directory', + 'children' => [ + 'CreatePolicy', + 'DeletePolicy', + 'SetDefaultPolicyVersion', + 'AttachPolicy', + 'DetachPolicy', + 'ListPolicies', + 'GetPolicy', + 'ListPolicyAttachments', + 'CreatePolicyVersion', + 'DeletePolicyVersion', + 'ListPolicyVersions', + 'GetPolicyVersion', + ], + ], + [ + 'id' => 190389, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + 'ListTagKeys', + 'ListTagValues', + ], + ], + [ + 'id' => 190390, + 'title' => '其他（不维护）', + 'type' => 'directory', + 'children' => [ + 'InitResourceDirectory', + 'CreateCloudAccount', + 'PromoteResourceAccount', + 'ResendPromoteResourceAccountEmail', + 'ResendCreateCloudAccountEmail', + 'CancelCreateCloudAccount', + 'CancelPromoteResourceAccount', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'EnableResourceDirectory' => [ + 'summary' => '调用EnableResourceDirectory开通资源目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'MAName', + 'in' => 'query', + 'schema' => [ + 'description' => '新管理账号名称。'."\n" + ."\n" + .'格式：`<前缀>@rdadmin.aliyunid.com`。其中，<前缀>允许输入英文字母、数字、特殊字符`_.-`，且必须以英文字母或数字开头和结尾，不能输入连续特殊字符。<前缀>的长度为2~50个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'user01@rdadmin.aliyunid.com', + ], + ], + [ + 'name' => 'MASecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => '新创建管理账号的安全手机号码。'."\n" + ."\n" + .'置空表示采用当前登录账号的安全手机号码。该手机号码必须与[SendVerificationCodeForEnableRD](~~364248~~)中获取验证码时使用的手机号码一致。'."\n" + ."\n" + .'格式：`<国家码>-<手机号码>`。'."\n" + ."\n" + .''."\n" + .'> 不支持填写`86-<手机号码>`的中国内地手机号码。'."\n" + ."\n\n" + .''."\n" + .'> 仅支持填写`86-<手机号码>`的中国内地手机号码。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xx-13900001234', + ], + ], + [ + 'name' => 'VerificationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '验证码。'."\n" + ."\n" + .'您可以调用[SendVerificationCodeForEnableRD](~~364248~~)获取验证码。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'EnableMode', + 'in' => 'query', + 'schema' => [ + 'description' => '开通方式。取值：'."\n" + ."\n" + .'- CurrentAccount：使用当前登录账号开通资源目录。'."\n" + .'- NewManagementAccount：新创建管理账号开通资源目录。该方式下，您需要配置`MAName`、`MASecureMobilePhone`和`VerificationCode`。', + 'type' => 'string', + 'required' => true, + 'example' => 'CurrentAccount', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ResourceDirectory' => [ + 'description' => '资源目录信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-54****', + ], + 'MasterAccountId' => [ + 'description' => '管理账号ID。', + 'type' => 'string', + 'example' => '507408460615****', + ], + 'MasterAccountName' => [ + 'description' => '管理账号名称。', + 'type' => 'string', + 'example' => 'alice@example.com', + ], + 'RootFolderId' => [ + 'description' => 'Root资源夹ID。', + 'type' => 'string', + 'example' => 'r-G9****', + ], + 'CreateTime' => [ + 'description' => '资源目录开通时间。', + 'type' => 'string', + 'example' => '2021-12-08T02:15:31.744Z', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"alice@example.com\\",\\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":"\\n EC2FE94D-A4A2-51A1-A493-5C273A36C46A\\n \\n rd-54****\\n alice@example.com\\n r-G9****\\n 2021-12-08T02:15:31.744Z\\n 507408460615****\\n \\n","errorExample":""}]', + 'title' => '开通资源目录', + 'description' => '您可以使用当前登录账号或新创建管理账号两种方式开通资源目录。更多信息，请参见[开通资源目录](~~111215~~)。'."\n" + ."\n" + .'本文将提供一个示例，使用当前登录账号开通资源目录。', + ], + 'SendVerificationCodeForEnableRD' => [ + 'summary' => '通过创建新管理账号开通资源目录时，调用 SendVerificationCodeForEnableRD 向新管理账号的安全手机号码发送验证码。', + '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' => '新创建的管理账号的安全手机号码。置空表示采用当前登录账号的安全手机号码。'."\n" + ."\n" + .'格式：`<国家码>-<手机号码>`。'."\n" + ."\n" + .''."\n" + .'> 不支持填写`86-<手机号码>`的中国内地手机号码。'."\n" + ."\n" + .''."\n" + .'> 仅支持填写`86-<手机号码>`的中国内地手机号码。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xx-13900001234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n EC2FE94D-A4A2-51A1-A493-5C273A36C46A\\n","errorExample":""}]', + 'title' => '发送验证码', + 'description' => '每个阿里云账号每天最多发送100次验证码。', + ], + 'GetResourceDirectory' => [ + 'summary' => '调用GetResourceDirectory获取资源目录信息。管理账号调用时，返回管理账号开通的资源目录详情。成员调用时，返回成员所属的资源目录详情。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => 'CD76D376-2517-4924-92C5-DBC52262F93A', + ], + 'ResourceDirectory' => [ + 'description' => '资源目录信息。', + 'type' => 'object', + 'properties' => [ + 'ControlPolicyStatus' => [ + 'description' => '管控策略状态。取值：'."\n" + ."\n" + .'- Enabled：已开启。'."\n" + .'- PendingEnable：开启中。'."\n" + .'- Disabled：已关闭。'."\n" + .'- PendingDisable：关闭中。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '资源目录开通时间。', + 'type' => 'string', + 'example' => '2019-02-18T15:32:10.473Z', + ], + 'IdentityInformation' => [ + 'description' => '成员实名信息。', + 'type' => 'string', + 'example' => '***有限公司', + ], + 'MasterAccountId' => [ + 'description' => '管理账号ID。', + 'type' => 'string', + 'example' => '172845045600****', + ], + 'MasterAccountName' => [ + 'description' => '管理账号名称。', + 'type' => 'string', + 'example' => 'aliyun-admin', + ], + 'MemberDeletionStatus' => [ + 'description' => '是否开启了成员删除许可。取值：'."\n" + .'- Enabled：已开启。允许通过调用[DeleteAccount](~~311546~~)删除资源账号类型的成员。'."\n" + .'- Disabled：已关闭。不允许删除资源账号类型的成员。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-St****', + ], + 'RootFolderId' => [ + 'description' => 'Root资源夹ID。', + '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":"\\n CD76D376-2517-4924-92C5-DBC52262F93A\\n \\n r-Zo****\\n rd-St****\\n 2019-02-18T15:32:10.473Z\\n 172845045600****\\n aliyun-admin\\n Enabled\\n Enabled\\n ***有限公司\\n \\n","errorExample":""}]', + 'title' => '获取资源目录信息', + 'description' => '本文将提供一个示例，使用管理账号查询其开通的资源目录详情。', + ], + 'DestroyResourceDirectory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '关闭资源目录', + 'summary' => '调用DestroyResourceDirectory关闭资源目录。此操作不可恢复，请您慎重操作。', + 'description' => '关闭资源目录前，请确认已完成以下操作：'."\n" + .'- 资源目录内所有成员已被移除。关于如何移除成员，请参见[RemoveCloudAccount](~~159431~~)。'."\n" + .'- 资源目录内除Root资源夹外的资源夹已全部删除。关于如何删除资源夹，请参见[DeleteFolder](~~159432~~)。', + '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' => '父资源夹ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-b1****', + ], + ], + [ + 'name' => 'FolderName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源夹名称。'."\n" + ."\n" + .'长度为1~24个字符或汉字，可包含汉字、英文字母、数字、下划线（_）、半角句号（.）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'rdFolder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + 'Folder' => [ + 'description' => '资源夹信息。', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-u8B321****', + ], + 'CreateTime' => [ + 'description' => '资源夹创建时间。', + 'type' => 'string', + 'example' => '2019-02-19T09:34:50.757Z', + ], + 'ParentFolderId' => [ + 'description' => '父资源夹ID。', + 'type' => 'string', + 'example' => 'r-b1****', + ], + 'FolderName' => [ + 'description' => '资源夹名称。', + '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":"\\r\\n\\r\\n \\r\\n rdFolder \\r\\n r-b1****\\r\\n fd-u8B321****\\r\\n 2019-02-19T09:34:50.757Z\\r\\n \\r\\n C2CBCA30-C8DD-423E-B4AD-4FB694C9180C\\r\\n","errorExample":""}]', + 'title' => '创建资源夹', + 'summary' => '调用CreateFolder创建资源夹。', + 'description' => '> 最多支持创建5级资源夹。'."\n" + ."\n" + .'本文将提供一个示例，在Root资源夹下，创建一个名为`rdFolder`的资源夹。', + 'requestParamsDescription' => ' 关于公共请求参数的详情，请参见[公共参数](~~159973~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetFolder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-Jyl5U7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + 'Folder' => [ + 'description' => '资源夹信息。', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-Jyl5U7****', + ], + 'CreateTime' => [ + 'description' => '资源夹创建时间。', + 'type' => 'string', + 'example' => '2021-06-15T06:39:08.521Z', + ], + 'ParentFolderId' => [ + 'description' => '父资源夹ID。', + 'type' => 'string', + 'example' => 'r-Wm****', + ], + 'FolderName' => [ + 'description' => '资源夹名称。', + 'type' => 'string', + 'example' => 'Applications', + ], + 'ResourceDirectoryPath' => [ + 'description' => '资源夹在资源目录中的路径ID（RDPath）。', + '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":"\\r\\n\\r\\n\\t88EF473E-D5CD-589F-AAB3-F6E0D12AECA3\\r\\n\\t\\r\\n\\t\\t2021-06-15T06:39:08.521Z\\r\\n\\t\\tfd-Jyl5U7****\\r\\n\\t\\tApplications\\r\\n\\t\\tr-Wm****\\r\\n\\t\\trd-3G****/r-Wm****/fd-Jyl5U7****\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取资源夹信息', + 'summary' => '调用GetFolder获取资源夹信息。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFolder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'FolderId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-u8B321****', + ], + ], + [ + 'name' => 'NewFolderName', + 'in' => 'query', + 'schema' => [ + 'description' => '新资源夹名称。'."\n" + ."\n" + .'长度为1~24个字符或汉字，可包含汉字、英文字母、数字、下划线（_）、点号（.）和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'rdFolder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C2CBCA30-C8DD-423E-B4AD-4FB694C9180C', + ], + 'Folder' => [ + 'description' => '资源夹信息。', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-u8B321****', + ], + 'CreateTime' => [ + 'description' => '资源夹创建时间。', + 'type' => 'string', + 'example' => '2019-02-19T09:34:50.757Z', + ], + 'ParentFolderId' => [ + 'description' => '父资源夹ID。', + 'type' => 'string', + 'example' => 'r-b1****', + ], + 'FolderName' => [ + 'description' => '资源夹名称。', + '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":"\\r\\n\\r\\n \\r\\n rdFolder\\r\\n r-b1****\\r\\n fd-u8B321****\\r\\n 2019-02-19T09:34:50.757Z\\r\\n \\r\\n C2CBCA30-C8DD-423E-B4AD-4FB694C9180C\\r\\n","errorExample":""}]', + 'title' => '修改资源夹名称', + 'summary' => '调用UpdateFolder修改资源夹名称。', + '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' => '资源夹ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ae1in7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '删除资源夹', + 'summary' => '调用DeleteFolder删除资源夹。', + 'description' => '> 删除资源夹前，请确保资源夹下不存在成员或子资源夹。', + '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' => '父资源夹ID。'."\n" + ."\n" + .'当该参数置空时，查询的是Root资源夹下的下一级子资源夹。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-b1****', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，例如：资源夹名称。'."\n" + ."\n" + .'支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'rdFolder', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'description' => '资源夹列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源夹列表。', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'rd-evic31****', + ], + 'CreateTime' => [ + 'description' => '资源夹创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'FolderName' => [ + 'description' => '资源夹名称。', + '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":"\\r\\n\\r\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\r\\n 1\\r\\n 5\\r\\n 2\\r\\n \\r\\n \\r\\n rd-evic31****\\r\\n project-1\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n \\r\\n fd-evic31****\\r\\n project-2\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n \\r\\n","errorExample":""}]', + 'title' => '查看指定资源夹的子资源夹信息', + 'summary' => '调用ListFoldersForParent查询指定资源夹的子资源夹列表。', + 'description' => '> 只能查看指定资源夹下一级的子资源夹列表，无法查看更深层级的资源夹列表。', + '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' => '子资源夹ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-i1c9nr****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '83AFBEB6-DC03-406E-9686-867461FF6698', + ], + 'Folders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Folder' => [ + 'description' => '资源夹信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资源夹信息。', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'r-b1****', + ], + 'CreateTime' => [ + 'description' => '资源夹创建时间。', + 'type' => 'string', + 'example' => '2019-01-18T10:03:35.217Z', + ], + 'FolderName' => [ + 'description' => '资源夹名称。', + '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":"\\r\\n\\r\\n \\r\\n \\r\\n root\\r\\n r-b1****\\r\\n 2019-01-18T10:03:35.217Z\\r\\n \\r\\n \\r\\n myFirstFd\\r\\n fd-0adR35****\\r\\n 2019-01-23T08:48:37.530Z\\r\\n \\r\\n \\r\\n 83AFBEB6-DC03-406E-9686-867461FF6698\\r\\n","errorExample":""}]', + 'title' => '查看指定资源夹的所有父资源夹信息', + 'summary' => '调用ListAncestors查看指定资源夹的所有父资源夹信息。返回结果将按照从上到下的顺序展示资源夹信息。', + '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' => '成员显示名称。'."\n" + ."\n" + .'长度范围：2~50个字符或汉字。'."\n" + ."\n" + .'格式：允许输入汉字、英文字母、数字、下划线（_）、半角句号（.）、短划线（-）和空格。'."\n" + ."\n" + .'成员显示名称在资源目录内必须唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'Dev', + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => '父资源夹ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fd-r23M55****', + ], + ], + [ + 'name' => 'PayerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '结算账号ID。置空则采用新创建的成员自主结算。', + 'type' => 'string', + 'required' => false, + 'example' => '12323344****', + ], + ], + [ + 'name' => 'AccountNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称前缀。置空则系统随机生成。'."\n" + ."\n" + .'长度范围：2~50个字符或汉字。'."\n" + ."\n" + .'长度范围：2~37个字符。'."\n" + ."\n" + .'格式：允许输入英文字母、数字和特殊字符`_.-`，必须以英文字母或数字开头和结尾，且不能输入连续的特殊字符`_.-`。'."\n" + ."\n" + .'完整账号名称的格式为@.aliyunid.com，例如：`alice@rd-3G****.aliyunid.com`'."\n" + ."\n" + .'账号名称在资源目录内必须唯一。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alice', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '成员的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '成员的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResellAccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '成员的身份类型。取值：'."\n" + ."\n" + .'- resell（默认值）：分销账号。创建的成员将自动与您的分销商建立分销关系，同时您需要使用管理账号为新成员付款。'."\n" + .'- non_resell ：非分销账号。创建的成员为阿里云普通账号，与您当前的分销商无关联关系，该账号直接从阿里云购买资源，需自主付款。'."\n" + ."\n" + .'> 该参数仅支持国际站分销客户。', + 'type' => 'string', + 'required' => false, + 'example' => 'resell', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '成员加入状态。取值为CreateSuccess，表示创建成功。', + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => '成员类型。取值为ResourceAccount，表示资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => '成员显示名称。', + 'type' => 'string', + 'example' => 'Dev', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-r23M55****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'JoinTime' => [ + 'description' => '成员加入时间（UTC时间）。', + 'type' => 'string', + 'example' => '2020-12-31T03:37:39.456Z', + ], + 'AccountId' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'example' => '112730938585****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。取值：'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2020-12-31T03:37:39.456Z', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'alice@rd-3g****.aliyunid.com', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n \\n CreateSuccess\\n ResourceAccount\\n Dev\\n fd-r23M55****\\n rd-3G****\\n 2020-12-31T03:37:39.456Z\\n 112730938585****\\n created\\n 2020-12-31T03:37:39.456Z\\n alice@rd-3g****.aliyunid.com\\n \\n B356A415-D860-43E5-865A-E2193D62BBD6\\n","errorExample":""}]', + 'title' => '创建资源账号类型的成员', + 'summary' => '调用CreateResourceAccount创建资源账号类型的成员。', + 'description' => '在资源目录内，成员作为资源容器，是一种资源分组单位。成员通常用于指代一个项目或应用，每个成员中的资源相对其他成员中的资源是物理隔离的。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'NewDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '新的成员名称。'."\n" + .'> `NewDisplayName`与`NewAccountType`任选其一设置，不能同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'NewAccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '新的成员类型。取值：'."\n" + ."\n" + .'- ResourceAccount：将指定的云账号切换为资源账号。'."\n" + .'- CloudAccount：将指定的资源账号切换为云账号。'."\n" + ."\n" + .'> `NewDisplayName`与`NewAccountType`任选其一设置，不能同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceAccount', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12323344****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '成员加入状态。取值：'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- InviteSuccess：邀请成功。'."\n" + .'- Removed：已移除。'."\n" + .'- SwitchSuccess：切换成功。', + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => '成员类型。取值：'."\n" + ."\n" + .'- CloudAccount：云账号。'."\n" + .'- ResourceAccount：资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'JoinTime' => [ + 'description' => '成员加入时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountId' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'example' => '12323344****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。取值：'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountName' => [ + 'description' => '阿里云账号名称。', + 'type' => 'string', + 'example' => 'ecs-manager@aliyun.com', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"ecs-manager@aliyun.com\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n \\r\\n rd-k3****\\r\\n 12323344****\\r\\n admin\\r\\n fd-bVaRIG****\\r\\n created\\r\\n 2015-01-23T12:33:18Z\\r\\n ResourceAccount\\r\\n CreateSuccess\\r\\n 06950264-3f0d-4ca9-82dd-6ee7a3d33d6b\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n","errorExample":""}]', + 'title' => '修改成员信息', + 'summary' => '调用UpdateAccount修改成员名称或切换成员类型。', + 'description' => '### 前提条件'."\n" + ."\n" + .'- 为确保系统可以记录到管理操作的具体操作者，请使用管理账号下具有资源目录管理权限（AliyunResourceDirectoryFullAccess）的RAM用户或RAM角色调用本API。'."\n" + .'- 资源账号切换为云账号时需要满足的条件，请参见[资源账号切换为云账号](~~111233~~)。'."\n" + .'- 云账号切换为资源账号时需要满足的条件，请参见[云账号切换为资源账号](~~209980~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回标签信息。取值：'."\n" + ."\n" + .'- false（默认值）：不返回。'."\n" + .'- true：返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '成员加入状态。取值：'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。', + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => '成员类型。取值：'."\n" + ."\n" + .'- CloudAccount：云账号。'."\n" + .'- ResourceAccount：资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'IdentityInformation' => [ + 'description' => '实名认证信息。', + 'type' => 'string', + 'example' => 'aliyun-admin', + ], + 'JoinTime' => [ + 'description' => '成员加入时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountId' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'example' => '181761095690****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。取值：'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'ResourceDirectoryPath' => [ + 'description' => '成员在资源目录中的路径ID（RDPath）。', + 'type' => 'string', + 'example' => 'rd-k3****/r-Wm****/fd-bVaRIG****/181761095690****', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tag_value', + ], + ], + ], + ], + 'Location' => [ + 'description' => '成员所在资源目录的位置。', + 'type' => 'string', + 'example' => 'root/AlRd****/Z5Aa****', + ], + 'EmailStatus' => [ + 'description' => '邮箱状态。取值：'."\n" + ."\n" + .'- 空：不存在邮箱修改记录。'."\n" + .'- WAIT_MODIFY：正在修改中。'."\n" + .'- CANCELLED：修改取消。'."\n" + .'- EXPIRED：修改过期。', + 'type' => 'string', + 'example' => 'WAIT_MODIFY', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"someone@example.com\\",\\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":"\\n \\n CreateSuccess\\n ResourceAccount\\n admin\\n fd-bVaRIG****\\n rd-k3****\\n aliyun-admin\\n 2015-01-23T12:33:18Z\\n 181761095690****\\n created\\n 2015-01-23T12:33:18Z\\n someone@example.com\\n rd-k3****/r-Wm****/fd-bVaRIG****/181761095690****\\n \\n tag_key\\n tag_value\\n \\n root/AlRd****/Z5Aa****\\n WAIT_MODIFY\\n \\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n","errorExample":""}]', + 'title' => '获取成员信息', + 'summary' => '调用GetAccount获取成员信息。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPayerForAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12323344****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PayerAccountName' => [ + 'description' => '结算账号名称。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'PayerAccountId' => [ + 'description' => '结算账号ID。', + '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":"\\r\\n\\r\\n\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n\\t172841235500****\\r\\n\\tAlice\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取结算账号信息', + 'summary' => '调用GetPayerForAccount获取成员的结算账号信息。', + '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' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '通过标签过滤。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤的标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag_value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回标签信息。取值：'."\n" + .'- false（默认值）：不返回。'."\n" + .'- true：返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '成员列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '成员加入状态。取值：'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。', + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => '成员类型。取值：'."\n" + ."\n" + .'- CloudAccount：云账号。'."\n" + .'- ResourceAccount：资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-QRzuim****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'JoinTime' => [ + 'description' => '成员加入时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-18T08:01:50.522Z', + ], + 'AccountId' => [ + 'description' => '成员账号ID。', + 'type' => 'string', + 'example' => '181761095690****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。取值：'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-18T08:04:37.668Z', + ], + 'ResourceDirectoryPath' => [ + 'description' => '成员在资源目录中的路径ID（RDPath）。', + 'type' => 'string', + 'example' => 'rd-3G****/r-Wm****/fd-QRzuim****/181761095690****', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '成员所有的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '成员所有的标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => '标签值。', + '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":"\\n 2\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n 1\\n 2\\n \\n CreateSuccess\\n ResourceAccount\\n test\\n fd-QRzuim****\\n rd-3G****\\n 2021-01-18T08:01:50.522Z\\n 181761095690****\\n created\\n 2021-01-18T08:04:37.668Z\\n rd-3G****/r-Wm****/fd-QRzuim****/181761095690****\\n \\n tag_key\\n tag_value\\n \\n \\n","errorExample":""}]', + 'title' => '查看整个资源目录下的成员信息', + 'summary' => '调用ListAccounts查询整个资源目录下的所有成员列表。', + 'description' => '资源目录的管理账号和可信服务的委派管理员账号可以调用该接口。', + 'requestParamsDescription' => ' 关于公共请求参数的详情，请参见[公共参数](~~159973~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAccountsForParent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fd-bVaRIG****', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，例如：成员名称。'."\n" + ."\n" + .'支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '通过标签过滤。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤的标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag_value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回标签信息。取值：'."\n" + ."\n" + .'- false（默认值）：不返回。'."\n" + .'- true：返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'array', + 'items' => [ + 'description' => '成员信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '成员加入状态。取值：'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。', + 'type' => 'string', + 'example' => 'CreateSuccess', + ], + 'Type' => [ + 'description' => '成员类型。取值：'."\n" + ."\n" + .'- CloudAccount：云账号。'."\n" + .'- ResourceAccount：资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k4****', + ], + 'JoinTime' => [ + 'description' => '成员加入时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'AccountId' => [ + 'description' => '成员账号ID。', + 'type' => 'string', + 'example' => '184311716100****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。取值：'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '成员所有的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '成员标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'description' => '标签值。', + '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":"\\n 2\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n 1\\n 2\\n \\n CreateSuccess\\n ResourceAccount\\n admin\\n fd-bVaRIG****\\n rd-k4****\\n 2015-01-23T12:33:18Z\\n 184311716100****\\n created\\n 2015-01-23T12:33:18Z\\n \\n tag_key\\n tag_value\\n \\n \\n","errorExample":""}]', + 'title' => '查看资源夹下的成员列表', + 'summary' => '调用ListAccountsForParent查询资源夹下的成员列表。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MoveAccount' => [ + 'summary' => '调用MoveAccount将成员移动到另一个资源夹。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要移动的账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12323344****', + ], + ], + [ + 'name' => 'DestinationFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资源夹ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-bVaRIG****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '将成员移动到另一个资源夹', + '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' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '177242285274****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '移除云账号类型的成员', + 'summary' => '调用RemoveCloudAccount移除云账号类型的成员。移除后，该成员将作为独立的阿里云账号存在，不再被资源目录的管理账号管控。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindSecureMobilePhone' => [ + 'summary' => '调用BindSecureMobilePhone为资源账号类型的成员设置安全手机号码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'VerificationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '验证码。'."\n" + ."\n" + .'您可以调用[SendVerificationCodeForBindSecureMobilePhone](~~372556~~)获取验证码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'SecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => '安全手机号码。'."\n" + ."\n" + .'该手机号码必须与[SendVerificationCodeForBindSecureMobilePhone](~~372556~~)中获取验证码时设置的手机号码一致。'."\n" + ."\n" + .'格式：<国家码>-<手机号码>。'."\n" + ."\n" + .''."\n" + .'> 仅支持填写`86-<手机号码>`的中国内地手机号码。'."\n" + ."\n\n" + .''."\n" + .'> 不支持填写`86-<手机号码>`的中国内地手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => 'xx-13900001234', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '138660628348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n 0217AFEB-5318-56D4-B167-1933D83EDF3F\\n","errorExample":""}]', + 'title' => '设置安全手机号码', + 'description' => '本API仅用于首次设置资源账号安全手机号码，不能用于修改已有的安全手机号码。'."\n" + ."\n" + .'为确保系统可以记录到管理操作的具体操作者，请使用管理账号下具有资源目录管理权限（AliyunResourceDirectoryFullAccess）的RAM用户或RAM角色调用本API。'."\n" + ."\n" + .'本文将提供一个示例，为成员`138660628348****`设置安全手机号码。', + ], + 'SendVerificationCodeForBindSecureMobilePhone' => [ + 'summary' => '为资源账号类型的成员设置安全手机号码时，调用SendVerificationCodeForBindSecureMobilePhone向安全手机发送验证码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SecureMobilePhone', + 'in' => 'query', + 'schema' => [ + 'description' => '安全手机号码。'."\n" + ."\n" + .'格式：<国家码>-<手机号码>。'."\n" + ."\n" + .''."\n" + .'> 仅支持填写`86-<手机号码>`的中国内地手机号码。'."\n" + ."\n\n" + .''."\n" + .'> 不支持填写`86-<手机号码>`的中国内地手机号码。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xx-13900001234', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员的账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '138660628348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DCD43660-75DD-5D15-B342-1B83FCA5B913', + ], + 'ExpirationDate' => [ + 'description' => '验证码过期时间。', + '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":"\\n DCD43660-75DD-5D15-B342-1B83FCA5B913\\n 2021-12-17T07:38:41.747Z\\n","errorExample":""}]', + 'title' => '向安全手机发送验证码', + 'description' => '为确保系统可以记录到管理操作的具体操作者，请使用管理账号下具有资源目录管理权限（AliyunResourceDirectoryFullAccess）的RAM用户或RAM角色调用本API。', + ], + 'ChangeAccountEmail' => [ + 'summary' => '调用ChangeAccountEmail修改成员邮箱。', + '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' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '成员邮箱。'."\n" + ."\n" + .'> 系统将自动发送验证邮件到所填邮箱，通过验证后修改才会生效，验证通过后系统会同步修改该账号的邮箱和安全邮箱。', + 'type' => 'string', + 'required' => true, + 'example' => 'someone@example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n","errorExample":""}]', + 'title' => '修改成员邮箱', + ], + 'RetryChangeAccountEmail' => [ + 'summary' => '调用RetryChangeAccountEmail重新发送修改成员邮箱的确认邮件。', + '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' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n","errorExample":""}]', + 'title' => '重新发送修改成员邮箱的确认邮件', + ], + 'CancelChangeAccountEmail' => [ + 'summary' => '调用CancelChangeAccountEmail取消修改成员邮箱。', + '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' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n","errorExample":""}]', + 'title' => '取消修改成员邮箱', + ], + 'CheckAccountDelete' => [ + 'summary' => '调用CheckAccountDelete执行成员删除检查任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '179855839641****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n 7CDDDCEF-CDFD-0825-B7D7-217BE0897B22\\n","errorExample":""}]', + 'title' => '成员删除检查', + 'description' => '删除成员前，您需要调用本API对目标成员进行删除前的条件检查。', + 'extraInfo' => '### 后续操作'."\n" + .'您可以调用[GetAccountDeletionCheckResult](~~448775~~)查询删除检查的结果。', + ], + 'DeleteAccount' => [ + 'summary' => '调用DeleteAccount删除资源类型的成员。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '169946124551****', + ], + ], + [ + 'name' => 'AbandonableCheckId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '可以选择放弃并继续执行成员删除的检查项ID。'."\n" + ."\n" + .'该ID从[GetAccountDeletionCheckResult](~~448775~~)的返回参数AbandonableChecks中获取。', + 'type' => 'array', + 'items' => [ + 'description' => '可以选择放弃并继续执行成员删除的检查项ID。'."\n" + ."\n" + .'该ID从[GetAccountDeletionCheckResult](~~448775~~)的返回参数AbandonableChecks中获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'NON_SP_cs', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '009429F8-C1C0-5872-B674-A6C2333B9647', + ], + 'DeletionType' => [ + 'description' => '删除类型。取值：'."\n" + ."\n" + .'- 0：直接删除。如果成员最近30天内不存在后付费资源，则系统会直接删除该成员。'."\n" + .'- 1：静默期删除。如果成员最近30天内存在后付费资源，则会进入静默期。等待静默期结束后，系统才会开始删除该成员。关于静默期的更多信息，请参见[什么是成员删除的静默期](~~446079~~)。', + '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":"\\n 55B22096-0D0C-542D-9A01-9B95977D3A10\\n 0\\n","errorExample":""}]', + 'title' => '删除资源类型的成员', + 'description' => '删除成员前，建议您先调用[CheckAccountDelete](~~448542~~)和[GetAccountDeletionCheckResult](~~448775~~)，对成员进行删除前的条件检查。只有符合删除条件的成员，才能调用DeleteAccount成功将其删除。'."\n" + ."\n" + .'成功提交成员删除申请后，您可以通过[GetAccountDeletionStatus](~~449001~~)查询删除状态。且成员一旦删除，成员中的所有资源及数据都会被删除，您无法再次登录和使用它，将无法找回，请您谨慎操作。关于成员删除的更多信息，请参见[删除资源账号类型的成员](~~446078~~)。', + ], + 'SetMemberDeletionPermission' => [ + 'summary' => '调用SetMemberDeletionPermission开启或关闭成员删除许可。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '开启或关闭成员删除许可。取值：'."\n" + ."\n" + .'- Enabled：开启。'."\n" + .'- Disabled：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'Enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C55A4CAA-9039-1DDF-91CE-FCC134513D29', + ], + 'MemberDeletionStatus' => [ + 'description' => '成员删除许可状态。取值：'."\n" + ."\n" + .'- Enabled：已开启。'."\n" + .'- Disabled：已关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'ManagementAccountId' => [ + 'description' => '资源目录的管理账号ID。', + 'type' => 'string', + 'example' => '151266687691****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + '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":"\\n rd-3G****\\n C55A4CAA-9039-1DDF-91CE-FCC134513D29\\n Enabled\\n 151266687691****\\n","errorExample":""}]', + 'title' => '开启或关闭成员删除许可', + 'description' => '当开启成员删除许可后，才能删除资源账号类型的成员。', + 'requestParamsDescription' => '关于公共请求参数的详情，请参见[公共参数](~~159973~~)。', + ], + 'GetAccountDeletionStatus' => [ + 'summary' => '调用GetAccountDeletionStatus查询成员删除状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '169946124551****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RdAccountDeletionStatus' => [ + 'description' => '成员删除状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- Success：删除成功。'."\n" + .'- Checking：检查中。'."\n" + .'- Deleting：删除中。'."\n" + .'- CheckFailed：检查失败。'."\n" + .'- DeleteFailed：删除失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'AccountId' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'example' => '169946124551****', + ], + 'CreateTime' => [ + 'description' => '删除开始时间。', + 'type' => 'string', + 'example' => '2022-08-23T17:05:30+08:00', + ], + 'DeletionTime' => [ + 'description' => '删除结束时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-23T17:06:01+08:00', + ], + 'FailReasonList' => [ + 'description' => '删除失败原因。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败原因。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项所属的云服务名称。', + 'type' => 'string', + 'example' => 'Others', + ], + 'Description' => [ + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => 'This account has a payer account. Please release the financial relationship of this account first.', + ], + ], + ], + ], + 'DeletionType' => [ + 'description' => '删除类型。取值：'."\n" + ."\n" + .'- 0：直接删除。如果成员最近30天内不存在后付费资源，则系统会直接删除该成员。'."\n" + .'- 1：静默期删除。如果成员最近30天内存在后付费资源，则会进入静默期。等待静默期结束后，系统才会开始删除该成员。关于静默期的更多信息，请参见[什么是成员删除的静默期](~~446079~~)。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\n 8AA43293-7C8F-5730-8F2D-7F864EC092C5\\n \\n Success\\n 169946124551****\\n 0\\n 2022-08-23T17:05:30+08:00\\n 2022-08-23T17:06:01+08:00\\n \\n","errorExample":""}]', + 'title' => '查询成员删除状态', + 'description' => '本文将提供一个示例，查询成员`169946124551****`的删除状态。返回结果显示，该成员已成功删除。', + ], + 'GetAccountDeletionCheckResult' => [ + 'summary' => '调用GetAccountDeletionCheckResult查询成员删除检查结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除成员的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '179855839641****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54AC391D-4F7F-5F08-B8D3-0AECDE6EC5BD', + ], + 'AccountDeletionCheckResultInfo' => [ + 'description' => '成员删除检查结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '检查状态。取值：'."\n" + ."\n" + .'- PreCheckComplete：检查完成。'."\n" + .'- PreChecking：检查中。', + 'type' => 'string', + 'example' => 'PreCheckComplete', + ], + 'AllowDelete' => [ + 'description' => '是否允许删除。取值：'."\n" + .'- true：允许删除。'."\n" + .'- false：不允许删除。', + 'type' => 'string', + 'example' => 'false', + ], + 'NotAllowReason' => [ + 'description' => '不允许删除的原因。'."\n" + .'> 当AllowDelete为false时，返回该参数值。', + 'type' => 'array', + 'items' => [ + 'description' => '不允许删除的原因。'."\n" + .'> 当AllowDelete为false时，返回该参数值。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => 'This account is an Enterprise Finance associated account. Please remove the financial association of this account before deleting it.', + ], + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'string', + 'example' => 'NON_SP_efc', + ], + 'CheckName' => [ + 'description' => '检查项所属的云服务名称。', + 'type' => 'string', + 'example' => 'Enterprise finance', + ], + ], + ], + ], + 'AbandonableChecks' => [ + 'description' => '您可以选择放弃并继续执行成员删除的检查项。'."\n" + ."\n" + .'> 当AllowDelete为true时，可能返回该参数值。', + 'type' => 'array', + 'items' => [ + 'description' => '您可以选择放弃并继续执行成员删除的检查项。'."\n" + .'> 当AllowDelete为true时，可能返回该参数值。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => '存在云产品实例运行，请联系客服人员提工单处理。', + ], + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'string', + 'example' => 'NON_SP_cs', + ], + 'CheckName' => [ + 'description' => '检查项所属的云服务名称。', + 'type' => 'string', + 'example' => '容器服务', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"\\n \\n PreCheckComplete\\n \\n instance number:1\\n eip_pre\\n SP_eip_eip_pre\\n \\n \\n This account is an Enterprise Finance associated account. Please remove the financial association of this account before deleting it.\\n Enterprise finance\\n NON_SP_efc\\n \\n false\\n \\n 54AC391D-4F7F-5F08-B8D3-0AECDE6EC5BD\\n","errorExample":""}]', + 'title' => '查询成员删除检查结果', + 'description' => '在您调用[CheckAccountDelete](~~448542~~)执行了成员删除检查任务后，您可以调用GetAccountDeletionCheckResult查询成员删除检查的结果。如果符合删除检查要求，则该成员允许删除；否则，请手动处理不符合项，直至符合要求为止。'."\n" + ."\n" + .'本文将提供一个示例，查询待删除成员`179855839641****`的删除检查结果。返回结果显示，该成员不符合删除要求。', + 'requestParamsDescription' => '关于公共请求参数的详情，请参见[公共参数](~~159973~~)。', + ], + 'InviteAccountToResourceDirectory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TargetEntity', + 'in' => 'query', + 'schema' => [ + 'description' => '被邀请账号ID或登录邮箱。', + 'type' => 'string', + 'required' => true, + 'example' => 'someone@example.com', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '被邀请账号类型。'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'required' => true, + 'example' => 'Email', + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => '备注。'."\n" + ."\n" + .'最大长度为1024个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '欢迎您加入', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => '邀请信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'TargetEntity' => [ + 'description' => '被邀请账号ID或登录邮箱。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'MasterAccountId' => [ + 'description' => '资源目录管理账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => '资源目录管理账号名称。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => '被邀请账号类型。取值：'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + '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\\": \\"someone@example.com\\",\\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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n h-ycm4rp****\\n rd-abcdef****\\n 172841235500****\\n Alice\\n someone@example.com\\n Email\\n 欢迎您加入\\n Pending\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n","errorExample":""}]', + 'title' => '邀请外部账号加入资源目录', + 'summary' => '调用InviteAccountToResourceDirectory邀请外部账号加入资源目录。', + 'description' => '本文将提供一个示例，邀请外部账号`someone@example.com`加入资源目录。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetHandshake' => [ + 'summary' => '调用GetHandshake获取邀请信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => '邀请ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'h-ycm4rp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => '邀请信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetEntity' => [ + 'description' => '被邀请账号ID或登录邮箱。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'MasterAccountId' => [ + 'description' => '资源目录管理账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + 'MasterAccountRealName' => [ + 'description' => '资源目录管理账号实名认证信息。'."\n" + ."\n" + .'> 被邀请方调用此接口时，才能查看该参数。', + 'type' => 'string', + 'example' => 'company', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'InvitedAccountRealName' => [ + 'description' => '被邀请方实名认证信息。'."\n" + ."\n" + .'> 被邀请方调用此接口时，才能查看该参数。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'MasterAccountName' => [ + 'description' => '资源目录管理账号名称。', + 'type' => 'string', + 'example' => 'company@example.com', + ], + 'TargetType' => [ + 'description' => '被邀请账号类型。取值：'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'example' => 'Email', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间（UTC时间）。', + '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\\": \\"someone@example.com\\",\\n \\"MasterAccountId\\": \\"172841235500****\\",\\n \\"HandshakeId\\": \\"h-ycm4rp****\\",\\n \\"MasterAccountRealName\\": \\"company\\",\\n \\"ResourceDirectoryId\\": \\"rd-abcdef****\\",\\n \\"InvitedAccountRealName\\": \\"Alice\\",\\n \\"Note\\": \\"欢迎您加入\\",\\n \\"MasterAccountName\\": \\"company@example.com\\",\\n \\"TargetType\\": \\"Email\\",\\n \\"ModifyTime\\": \\"2018-08-10T09:55:41Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n h-ycm4rp****\\n rd-abcdef****\\n 172841235500****\\n company@example.com\\n company\\n Alice\\n someone@example.com\\n Email\\n 欢迎您加入\\n Pending\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n","errorExample":""}]', + 'title' => '获取邀请信息', + 'description' => '本文将提供一个示例，获取ID为`h-ycm4rp****`的邀请信息。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelHandshake' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => '邀请ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'h-ycm4rp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => '邀请信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Cancelled', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'h-ycm4rp****', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'TargetEntity' => [ + 'description' => '被邀请账号ID或登录邮箱。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'MasterAccountId' => [ + 'description' => '资源目录管理账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => '资源目录管理账号名称。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => '被邀请账号类型。取值：'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + '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\\": \\"someone@example.com\\",\\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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n h-ycm4rp****\\n rd-abcdef****\\n 172841235500****\\n Alice\\n someone@example.com\\n Email\\n 欢迎您加入\\n Cancelled\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n","errorExample":""}]', + 'title' => '取消邀请', + 'summary' => '调用CancelHandshake取消邀请。', + 'description' => '本文将提供一个示例，取消ID为`h-ycm4rp****`的邀请。', + 'extraInfo' => ' ', + ], + 'ListHandshakesForAccount' => [ + 'summary' => '调用ListHandshakesForAccount查询当前账号下的邀请记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '邀请记录总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Handshakes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Handshake' => [ + 'description' => '邀请记录。', + 'type' => 'array', + 'items' => [ + 'description' => '邀请记录', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'TargetEntity' => [ + 'description' => '被邀请的阿里云账号ID或登录邮箱。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'MasterAccountId' => [ + 'description' => '资源目录管理账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => '资源目录管理账号名称。', + 'type' => 'string', + 'example' => 'CompanyA', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => '被邀请的阿里云账号类型。取值：'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + '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\\": \\"someone@example.com\\",\\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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n 1\\n 10\\n 2\\n \\n \\n h-4N57QZzCTtES****\\n rd-abcdef****\\n 172841235500****\\n CompanyA\\n someone@example.com\\n Email\\n 欢迎您加入\\n Pending\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n \\n h-BeJZW63fHT4l****\\n rd-abcdef****\\n 172841235500****\\n CompanyA\\n 172841235500****\\n Account\\n 欢迎您加入\\n Pending\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n \\n","errorExample":""}]', + 'title' => '查看当前账号下的邀请记录', + 'description' => '本文将提供一个示例，查询当前管理账号`172841235500****`的邀请记录。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListHandshakesForResourceDirectory' => [ + 'summary' => '调用ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Handshakes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Handshake' => [ + 'description' => '邀请信息。', + 'type' => 'array', + 'items' => [ + 'description' => '邀请信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-24T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'TargetEntity' => [ + 'description' => '被邀请账号ID或登录邮箱。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'MasterAccountId' => [ + 'description' => '资源目录管理账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => '资源目录管理账号名称。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => '被邀请账号类型。取值：'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + '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\\": \\"someone@example.com\\",\\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":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n 1\\n 10\\n 2\\n \\n \\n h-ycm4rp****\\n rd-abcdef****\\n 172841235500****\\n Alice\\n someone@example.com\\n Email\\n 欢迎您加入\\n Pending\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n \\n h-ycm4rp****\\n rd-abcdef****\\n 172841235500****\\n Alice\\n 172841235500****\\n Account\\n 欢迎您加入\\n Pending\\n 2018-08-10T09:55:41Z\\n 2018-08-10T09:55:41Z\\n 2018-08-24T09:55:41Z\\n \\n \\n","errorExample":""}]', + 'title' => '查看资源目录下的所有邀请列表', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AcceptHandshake' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => '邀请ID。'."\n" + ."\n" + .'您可以调用[ListHandshakesForAccount](~~160006~~)获取邀请ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'h-Ih8IuPfvV0t0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5828C836-3286-49A6-9006-15231BB19342', + ], + 'Handshake' => [ + 'description' => '邀请信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Accepted', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-20T02:15:40Z', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-06T02:15:40Z', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'TargetEntity' => [ + 'description' => '被邀请的阿里云账号ID或登录邮箱。', + 'type' => 'string', + 'example' => '177242285274****', + ], + 'MasterAccountId' => [ + 'description' => '资源目录的管理账号ID。', + 'type' => 'string', + 'example' => '151266687691****', + ], + 'MasterAccountName' => [ + 'description' => '资源目录的管理账号名称。', + 'type' => 'string', + 'example' => 'CompanyA', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-06T02:16:40Z', + ], + 'TargetType' => [ + 'description' => '被邀请的阿里云账号类型。取值：'."\n" + ."\n" + .'- Account：阿里云账号ID。'."\n" + .'- Email：阿里云账号登录邮箱。', + 'type' => 'string', + 'example' => 'Account', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + '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":"\\n 5828C836-3286-49A6-9006-15231BB19342\\n \\n Accepted\\n 2021-01-06T02:16:40Z\\n rd-3G****\\n h-Ih8IuPfvV0t0****\\n 欢迎您加入\\n 2021-01-06T02:15:40Z\\n Account\\n 151266687691****\\n CompanyA\\n 2021-01-20T02:15:40Z\\n 177242285274****\\n \\n","errorExample":""}]', + 'title' => '被邀请的阿里云账号接受邀请', + 'summary' => '被邀请的阿里云账号调用AcceptHandshake接受邀请。', + 'description' => '被邀请的阿里云账号成功加入资源目录后，会成为资源目录的成员。资源目录默认使用被邀请的阿里云账号名称作为该成员的成员名称和账号名称。'."\n" + ."\n" + .'本文将提供一个示例，被邀请的阿里云账号`177242285274****`接受来自资源目录`rd-3G****`的邀请，邀请ID是`h-Ih8IuPfvV0t0****`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeclineHandshake' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HandshakeId', + 'in' => 'query', + 'schema' => [ + 'description' => '邀请ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'h-ycm4rp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'Handshake' => [ + 'description' => '邀请信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态。取值：'."\n" + ."\n" + .'- Pending：等待确认。'."\n" + .'- Accepted：已接受。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Declined：已拒绝。'."\n" + .'- Expired：超时。', + 'type' => 'string', + 'example' => 'Declined', + ], + 'ExpireTime' => [ + 'description' => '邀请的过期时间。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-abcdef****', + ], + 'CreateTime' => [ + 'description' => '邀请的创建时间。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'Note' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '欢迎您加入', + ], + 'TargetEntity' => [ + 'description' => '被邀请账号ID或登录邮箱。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'MasterAccountId' => [ + 'description' => '资源目录主账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => '资源目录主账号名称。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'ModifyTime' => [ + 'description' => '邀请的修改时间。', + 'type' => 'string', + 'example' => '2018-08-10T09:55:41Z', + ], + 'TargetType' => [ + 'description' => '被邀请账号类型。取值：'."\n" + ."\n" + .'- Account：账号ID。'."\n" + .'- Email：账号登录邮箱。', + 'type' => 'string', + 'example' => 'Email', + ], + 'HandshakeId' => [ + 'description' => '邀请ID。', + '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\\": \\"someone@example.com\\",\\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":"\\r\\n\\r\\n\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n\\t\\r\\n\\t\\th-ycm4rp****\\r\\n\\t\\trd-abcdef****\\r\\n\\t\\t172841235500****\\r\\n\\t\\tAlice\\r\\n\\t\\tsomeone@example.com\\r\\n\\t\\tEmail\\r\\n\\t\\t欢迎您加入\\r\\n\\t\\tDeclined\\r\\n\\t\\t2018-08-10T09:55:41Z\\r\\n\\t\\t2018-08-10T09:55:41Z\\r\\n\\t\\t2018-08-17T09:55:41Z7\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '被邀请的阿里云账号拒绝邀请', + 'summary' => '被邀请的阿里云账号调用DeclineHandshake拒绝邀请。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableControlPolicy' => [ + 'summary' => '调用EnableControlPolicy开启管控策略功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnablementStatus' => [ + 'description' => '管控策略状态。取值：'."\n" + ."\n" + .'- Enabled：已开启。'."\n" + .'- PendingEnable：开启中。'."\n" + .'- Disabled：已关闭。'."\n" + .'- PendingDisable：关闭中。', + 'type' => 'string', + 'example' => 'PendingEnable', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\tPendingEnable\\r\\n\\t8CE7BD95-EFFA-4911-A1E0-BD4412697FEB\\r\\n","errorExample":""}]', + 'title' => '开启管控策略功能', + 'description' => '资源目录管控策略是一种基于资源结构（资源夹或成员账号）的访问控制策略，可以统一管理资源目录各层级内资源访问的权限边界，建立企业整体访问控制原则或局部专用原则。管控策略只定义权限边界，并不真正授予权限，您还需要在某个成员账号中使用访问控制（RAM）设置权限后，相应身份才具备对资源的访问权限。更多信息，请参见[管控策略概述](~~178671~~)。', + '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' => '管控策略状态。取值：'."\n" + ."\n" + .'- Enabled：已开启。'."\n" + .'- PendingEnable：开启中。'."\n" + .'- Disabled：已关闭。'."\n" + .'- PendingDisable：关闭中。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\tDisabled\\r\\n\\t1DC39A4E-3B52-4EFE-9F93-4897D7FFA0C4\\r\\n","errorExample":""}]', + 'title' => '查询管控策略功能的开启或关闭状态', + 'summary' => '调用GetControlPolicyEnablementStatus查询管控策略功能的开启或关闭状态。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableControlPolicy' => [ + 'summary' => '调用DisableControlPolicy关闭管控策略功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnablementStatus' => [ + 'description' => '管控策略状态。取值：'."\n" + ."\n" + .'- Enabled：已开启。'."\n" + .'- PendingEnable：开启中。'."\n" + .'- Disabled：已关闭。'."\n" + .'- PendingDisable：关闭中。', + 'type' => 'string', + 'example' => 'PendingDisable', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\tPendingDisable\\r\\n\\t7C709979-451D-4C92-835D-7DDCCAA562E9\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '关闭管控策略功能', + 'description' => '关闭管控策略功能后，您绑定到资源夹和成员账号上的管控策略会全部自动解绑。但管控策略本身不会被删除，只是不能再绑定到任何目标节点上。'."\n" + ."\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' => '管控策略名称。'."\n" + ."\n" + .'长度为1~128个字符，必须以英文字母开头，可以包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ExampleControlPolicy', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略描述。'."\n" + ."\n" + .'长度为1~1024个字符，必须以英文字母开头，可以包含英文字母、数字、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ExampleControlPolicy', + ], + ], + [ + 'name' => 'EffectScope', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略的生效范围。'."\n" + ."\n" + .'取值：RAM，表示该管控策略仅针对RAM用户或RAM角色生效。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RAM', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略内容。'."\n" + ."\n" + .'最大长度为4096个字符。'."\n" + ."\n" + .'管控策略语言，请参见[管控策略语言](~~179096~~)。'."\n" + ."\n" + .'管控策略示例，请参见[自定义管控策略示例](~~181474~~)。', + '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' => '管控策略详情。', + 'type' => 'object', + 'properties' => [ + 'UpdateDate' => [ + 'description' => '管控策略更新时间。', + 'type' => 'string', + 'example' => '2021-03-18T09:24:19Z', + ], + 'Description' => [ + 'description' => '管控策略描述。', + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => '管控策略生效范围。'."\n" + ."\n\n" + .'取值：RAM，表示该管控策略仅针对RAM用户或RAM角色生效。', + 'type' => 'string', + 'example' => 'RAM', + ], + 'AttachmentCount' => [ + 'description' => '管控策略被引用的次数。', + 'type' => 'string', + 'example' => '0', + ], + 'PolicyName' => [ + 'description' => '管控策略名称。', + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'PolicyId' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'example' => 'cp-jExXAqIYkwHN****', + ], + 'CreateDate' => [ + 'description' => '管控策略创建时间。', + 'type' => 'string', + 'example' => '2021-03-18T09:24:19Z', + ], + 'PolicyType' => [ + 'description' => '管控策略类型。取值：'."\n" + ."\n" + .'- System：系统管控策略。'."\n" + .'- Custom：自定义管控策略。', + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t\\r\\n\\t\\tCustom\\r\\n\\t\\t2021-03-18T09:24:19Z\\r\\n\\t\\tExampleControlPolicy\\r\\n\\t\\t0\\r\\n\\t\\tExampleControlPolicy\\r\\n\\t\\t2021-03-18T09:24:19Z\\r\\n\\t\\tcp-jExXAqIYkwHN****\\r\\n\\t\\tRAM\\r\\n\\t\\r\\n\\t776B05B3-A0B0-464B-A191-F4E1119A94B2\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建自定义管控策略', + 'summary' => '调用CreateControlPolicy创建自定义管控策略。', + 'description' => '本文将提供一个示例，创建一个名为`ExampleControlPolicy`的管控策略，禁止修改ResourceDirectoryAccountAccessRole角色及其权限。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cp-SImPt8GCEwiq****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果中管控策略描述的语言。取值：'."\n" + ."\n" + .'- zh-CN（默认值）：中文。'."\n" + .'- en：英文。'."\n" + .'- ja：日文。'."\n" + ."\n" + .'> 该参数仅在系统管控策略时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ControlPolicy' => [ + 'description' => '管控策略详情。', + 'type' => 'object', + 'properties' => [ + 'PolicyDocument' => [ + 'description' => '管控策略内容。', + 'type' => 'string', + 'example' => '{\\"Version\\":\\"1\\",\\"Statement\\":[{\\"Effect\\":\\"Deny\\",\\"Action\\":[\\"ram:UpdateRole\\",\\"ram:DeleteRole\\",\\"ram:AttachPolicyToRole\\",\\"ram:DetachPolicyFromRole\\"],\\"Resource\\":\\"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole\\"}]}', + ], + 'UpdateDate' => [ + 'description' => '管控策略更新时间。', + 'type' => 'string', + 'example' => '2021-03-18T08:51:33Z', + ], + 'Description' => [ + 'description' => '管控策略描述。', + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => '管控策略生效范围。取值：'."\n" + ."\n" + .'- All：表示该管控策略针对阿里云账号、RAM用户或RAM角色生效。'."\n" + .'- RAM：表示该管控策略仅针对RAM用户或RAM角色生效。', + 'type' => 'string', + 'example' => 'RAM', + ], + 'AttachmentCount' => [ + 'description' => '管控策略被引用的次数。', + 'type' => 'string', + 'example' => '0', + ], + 'PolicyName' => [ + 'description' => '管控策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'PolicyId' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'example' => 'cp-SImPt8GCEwiq****', + ], + 'CreateDate' => [ + 'description' => '管控策略创建时间。', + 'type' => 'string', + 'example' => '2021-03-18T08:51:33Z', + ], + 'PolicyType' => [ + 'description' => '管控策略类型。取值：'."\n" + ."\n" + .'- System：系统管控策略。'."\n" + .'- Custom：自定义管控策略。', + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t\\r\\n\\t\\tCustom\\r\\n\\t\\t2021-03-18T08:51:33Z\\r\\n\\t\\tExampleControlPolicy\\r\\n\\t\\t0\\r\\n\\t\\ttest\\r\\n\\t\\t{"Version":"1","Statement":[{"Effect":"Deny","Action":["ram:UpdateRole","ram:DeleteRole","ram:AttachPolicyToRole","ram:DetachPolicyFromRole"],"Resource":"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole"}]}\\r\\n\\t\\t2021-03-18T08:51:33Z\\r\\n\\t\\tcp-SImPt8GCEwiq****\\r\\n\\t\\tRAM\\r\\n\\t\\r\\n\\tAB769936-CDFA-4D52-8CE2-A3581800044A\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询管控策略详情', + 'summary' => '调用GetControlPolicy查询管控策略的详情。', + 'description' => '本文将提供一个示例，查询ID为`cp-SImPt8GCEwiq****`的管控策略详情。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'NewPolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '新的管控策略名称。'."\n" + ."\n" + .'长度为1~128个字符，必须以英文字母开头，可以包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'NewControlPolicy', + ], + ], + [ + 'name' => 'NewDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '新的管控策略描述。'."\n" + ."\n" + .'长度为1~1024个字符，必须以英文字母开头，可以包含英文字母、数字、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ExampleControlPolicy', + ], + ], + [ + 'name' => 'NewPolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '新的管控策略内容。'."\n" + ."\n" + .'最大长度为4096个字符。'."\n" + ."\n" + .'管控策略语言，请参见[管控策略语言](~~179096~~)。'."\n" + ."\n" + .'管控策略示例，请参见[自定义管控策略示例](~~181474~~)。', + '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' => '管控策略详情。', + 'type' => 'object', + 'properties' => [ + 'UpdateDate' => [ + 'description' => '管控策略更新时间。', + 'type' => 'string', + 'example' => '2021-03-18T10:04:55Z', + ], + 'Description' => [ + 'description' => '管控策略描述。', + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => '管控策略生效范围。取值：'."\n" + ."\n" + .'- All：表示该管控策略针对阿里云账号、RAM用户或RAM角色生效。'."\n" + .'- RAM：表示该管控策略仅针对RAM用户或RAM角色生效。', + 'type' => 'string', + 'example' => 'RAM', + ], + 'AttachmentCount' => [ + 'description' => '管控策略被引用的次数。', + 'type' => 'string', + 'example' => '0', + ], + 'PolicyName' => [ + 'description' => '管控策略名称。', + 'type' => 'string', + 'example' => 'NewControlPolicy', + ], + 'PolicyId' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'example' => 'cp-jExXAqIYkwHN****', + ], + 'CreateDate' => [ + 'description' => '管控策略创建时间。', + 'type' => 'string', + 'example' => '2021-03-18T09:24:19Z', + ], + 'PolicyType' => [ + 'description' => '管控策略类型。取值：'."\n" + ."\n" + .'- System：系统管控策略。'."\n" + .'- Custom：自定义管控策略。', + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t\\r\\n\\t\\tCustom\\r\\n\\t\\t2021-03-18T10:04:55Z\\r\\n\\t\\tExampleControlPolicy\\r\\n\\t\\t0\\r\\n\\t\\tNewControlPolicy\\r\\n\\t\\t2021-03-18T09:24:19Z\\r\\n\\t\\tcp-jExXAqIYkwHN****\\r\\n\\t\\tRAM\\r\\n\\t\\r\\n\\t2DFCE4C9-04A9-4C83-BB14-FE791275EC53\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '修改自定义管控策略', + 'summary' => '调用UpdateControlPolicy修改自定义管控策略。', + 'description' => '本文将提供一个示例，修改管控策略`cp-jExXAqIYkwHN****`的名称为`NewControlPolicy`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteControlPolicy' => [ + 'summary' => '调用DeleteControlPolicy删除自定义管控策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cp-SImPt8GCEwiq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C8541E06-B207-46BF-92C9-DC8DE4609D75', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C8541E06-B207-46BF-92C9-DC8DE4609D75\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tC8541E06-B207-46BF-92C9-DC8DE4609D75\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '删除自定义管控策略', + 'description' => '对于已绑定了资源夹或成员账号的自定义管控策略，需要先调用[DetachControlPolicy](~~208331~~)解绑，然后才能删除。'."\n" + ."\n" + .'本文将提供一个示例，删除自定义管控策略`cp-SImPt8GCEwiq****`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标节点。取值：'."\n" + ."\n" + .'- Root ID：为Root资源夹绑定管控策略。'."\n" + .'- 资源夹ID：为资源夹绑定管控策略。'."\n" + .'- 成员ID：为成员绑定管控策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ZDNPiT****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t95060F1D-6990-4645-8920-A81D1BBFE992\\r\\n","errorExample":""}]', + 'title' => '绑定自定义管控策略', + 'summary' => '调用AttachControlPolicy绑定管控策略。', + 'description' => '绑定成功后，资源夹或成员将会立即受到管控策略的管控。请务必确定绑定操作的结果是符合预期的，以免影响您的业务正常运行。'."\n" + ."\n" + .'系统会默认为资源夹和成员绑定系统策略FullAliyunAccess。'."\n" + ."\n" + .'管控策略在绑定节点下整体生效，即父资源夹绑定的管控策略，会在其子资源夹及其成员上生效。'."\n" + ."\n" + .'每个节点（资源夹、成员）最多允许绑定10条管控策略。'."\n" + ."\n" + .'本文将提供一个示例，为资源夹`fd-ZDNPiT****`绑定自定义策略`cp-jExXAqIYkwHN****`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachControlPolicy' => [ + 'summary' => '调用DetachControlPolicy解绑管控策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标节点。取值：'."\n" + ."\n" + .'- Root ID：为Root资源夹解绑管控策略。'."\n" + .'- 资源夹ID：为资源夹解绑管控策略。'."\n" + .'- 成员ID：为成员解绑管控策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ZDNPiT****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '解绑自定义管控策略', + 'description' => '解绑成功后，原绑定的资源夹或成员将会立即失去管控策略的管控。请务必确定解绑操作的结果是符合预期的，以免影响您的业务正常运行。'."\n" + ."\n" + .'系统策略和自定义管控策略都可以解绑，但资源夹或成员上绑定的最后一条管控策略不允许解绑。'."\n" + ."\n" + .'本文将提供一个示例，为资源夹`fd-ZDNPiT****`解绑自定义策略`cp-jExXAqIYkwHN****`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListControlPolicies' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略类型。取值：'."\n" + ."\n" + .'- System：系统管控策略。'."\n" + .'- Custom：自定义管控策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'System', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果中管控策略描述的语言。取值：'."\n" + ."\n" + .'- zh-CN（默认值）：中文。'."\n" + .'- en：英文。'."\n" + .'- ja：日文。'."\n" + ."\n" + .'> 该参数仅在系统管控策略时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '管控策略数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9424A34C-3471-45AD-B6AB-924BBDFE42F9', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ControlPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ControlPolicy' => [ + 'description' => '管控策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管控策略列表。', + 'type' => 'object', + 'properties' => [ + 'UpdateDate' => [ + 'description' => '管控策略更新时间。', + 'type' => 'string', + 'example' => '2020-08-05T06:32:24Z', + ], + 'Description' => [ + 'description' => '管控策略描述。', + 'type' => 'string', + 'example' => '支持阿里云所有操作的系统管控策略', + ], + 'EffectScope' => [ + 'description' => '管控策略生效范围。取值：'."\n" + ."\n" + .'- All：表示该管控策略针对阿里云账号、RAM用户或RAM角色生效。'."\n" + .'- RAM：表示该管控策略仅针对RAM用户或RAM角色生效。'."\n", + 'type' => 'string', + 'example' => 'All', + ], + 'AttachmentCount' => [ + 'description' => '管控策略被引用的次数。', + 'type' => 'string', + 'example' => '44', + ], + 'PolicyName' => [ + 'description' => '管控策略名称。', + 'type' => 'string', + 'example' => 'FullAliyunAccess', + ], + 'PolicyId' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'example' => 'cp-FullAliyunAccess', + ], + 'CreateDate' => [ + 'description' => '管控策略创建时间。', + 'type' => 'string', + 'example' => '2020-08-05T06:32:24Z', + ], + 'PolicyType' => [ + 'description' => '管控策略类型。取值：'."\n" + ."\n" + .'- System：系统管控策略。'."\n" + .'- Custom：自定义管控策略。', + '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":"\\r\\n\\r\\n\\t1\\r\\n\\t9424A34C-3471-45AD-B6AB-924BBDFE42F9\\r\\n\\t10\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tSystem\\r\\n\\t\\t\\t2020-08-05T06:32:24Z\\r\\n\\t\\t\\t支持阿里云所有操作的系统管控策略\\r\\n\\t\\t\\t44\\r\\n\\t\\t\\tFullAliyunAccess\\r\\n\\t\\t\\t2020-08-05T06:32:24Z\\r\\n\\t\\t\\tcp-FullAliyunAccess\\r\\n\\t\\t\\tAll\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询管控策略列表', + 'summary' => '调用ListControlPolicies查询管控策略列表。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListControlPolicyAttachmentsForTarget' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标节点。取值：'."\n" + ."\n" + .'- Root ID：查询Root节点绑定的管控策略。'."\n" + .'- 资源夹ID：查询资源夹绑定的管控策略。'."\n" + .'- 成员ID：查询成员绑定的管控策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd-ZDNPiT****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果中管控策略描述的语言。取值：'."\n" + ."\n" + .'- zh-CN（默认值）：中文。'."\n" + .'- en：英文。'."\n" + .'- ja：日文。'."\n" + ."\n" + .'> 该参数仅在系统管控策略时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C276B600-7B7A-49E8-938C-E16CFA955A82', + ], + 'ControlPolicyAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ControlPolicyAttachment' => [ + 'description' => '已绑定的管控策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已绑定的管控策略列表。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '管控策略描述。', + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'EffectScope' => [ + 'description' => '管控策略生效范围。取值：'."\n" + ."\n" + .'- All：表示该管控策略针对阿里云账号、RAM用户或RAM角色生效。'."\n" + .'- RAM：表示该管控策略仅针对RAM用户或RAM角色生效。', + 'type' => 'string', + 'example' => 'RAM', + ], + 'PolicyName' => [ + 'description' => '管控策略名称。', + 'type' => 'string', + 'example' => 'ExampleControlPolicy', + ], + 'PolicyId' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'example' => 'cp-jExXAqIYkwHN****', + ], + 'AttachDate' => [ + 'description' => '绑定管控策略的时间。', + 'type' => 'string', + 'example' => '2021-03-19T02:56:24Z', + ], + 'PolicyType' => [ + 'description' => '管控策略类型。取值：'."\n" + ."\n" + .'- System：系统管控策略。'."\n" + .'- Custom：自定义管控策略。', + '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":"\\r\\n\\r\\n\\tC276B600-7B7A-49E8-938C-E16CFA955A82\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tSystem\\r\\n\\t\\t\\t支持阿里云所有操作的系统管控策略\\r\\n\\t\\t\\t2021-03-18T07:27:59Z\\r\\n\\t\\t\\tFullAliyunAccess\\r\\n\\t\\t\\tcp-FullAliyunAccess\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tCustom\\r\\n\\t\\t\\tExampleControlPolicy\\r\\n\\t\\t\\t2021-03-19T02:56:24Z\\r\\n\\t\\t\\tExampleControlPolicy\\r\\n\\t\\t\\tcp-jExXAqIYkwHN****\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询节点绑定的管控策略', + 'summary' => '调用ListControlPolicyAttachmentsForTarget查询资源夹或成员账号绑定的管控策略列表。', + 'description' => '本文将提供一个示例，查询资源夹`fd-ZDNPiT****`绑定的管控策略列表。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTargetAttachmentsForControlPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '管控策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cp-jExXAqIYkwHN****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '绑定的目标节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B32BD3D6-1089-41F3-8E70-E0079BC7D760', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TargetAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetAttachment' => [ + 'description' => '绑定的目标节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定的目标节点列表。', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => '绑定的目标节点ID。', + 'type' => 'string', + 'example' => 'fd-ZDNPiT****', + ], + 'TargetName' => [ + 'description' => '绑定的目标节点名称。', + 'type' => 'string', + 'example' => 'Dev_Department', + ], + 'AttachDate' => [ + 'description' => '管控策略绑定时间。', + 'type' => 'string', + 'example' => '2021-03-19T02:56:24Z', + ], + 'TargetType' => [ + 'description' => '绑定的目标节点类型。取值：'."\n" + ."\n" + .'- Root：Root节点。'."\n" + .'- Folder：资源夹。'."\n" + .'- Account：成员账号。', + '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":"\\r\\n\\r\\n\\t1\\r\\n\\tB32BD3D6-1089-41F3-8E70-E0079BC7D760\\r\\n\\t10\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t2021-03-19T02:56:24Z\\r\\n\\t\\t\\tFolder\\r\\n\\t\\t\\tDev_Department\\r\\n\\t\\t\\tfd-ZDNPiT****\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询管控策略绑定的节点', + 'summary' => '调用ListTargetAttachmentsForControlPolicy查询管控策略绑定的节点。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTrustedServiceStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AdminAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '管理账号或委派管理员账号。取值：'."\n" + .'- 管理账号（默认值）：查询管理账号已启用的可信服务列表。'."\n" + .'- 委派管理员账号：查询委派管理员账号已启用的可信服务列表。'."\n" + ."\n" + .'关于可信服务和委派管理员账号的更多信息，请参见[可信服务概述](~~208133~~)和[管理委派管理员账号](~~208117~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '177242285274****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD76D376-2517-4924-92C5-DBC52262F93A', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnabledServicePrincipals' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EnabledServicePrincipal' => [ + 'description' => '已启用的可信服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已启用的可信服务列表。', + 'type' => 'object', + 'properties' => [ + 'ServicePrincipal' => [ + 'description' => '可信服务标识。', + 'type' => 'string', + 'example' => 'config.aliyuncs.com', + ], + 'EnableTime' => [ + 'description' => '启用可信服务的时间。', + '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":"\\r\\n\\r\\n \\r\\n config.aliyuncs.com\\r\\n 2019-02-18T15:32:10.473Z\\r\\n \\r\\n \\r\\n actiontrail.aliyuncs.com\\r\\n 2019-02-16T15:32:10.473Z\\r\\n \\r\\n CD76D376-2517-4924-92C5-DBC52262F93A\\r\\n","errorExample":""}]', + 'title' => '查询已启用的可信服务列表', + 'summary' => '调用ListTrustedServiceStatus查询管理账号或委派管理员账号已启用的可信服务列表。', + 'description' => '> 该接口仅限管理账号或委派管理员账号使用。', + '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' => '资源目录中的成员账号UID。', + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'ServicePrincipal', + 'in' => 'query', + 'schema' => [ + 'description' => '可信服务的标识。'."\n" + ."\n" + .'具体信息，请参见[支持的可信服务](~~208133~~)中的`可信服务标识`列。', + 'type' => 'string', + 'required' => true, + 'example' => 'cloudfw.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t0A45FC8F-54D2-4A65-8338-25E5DEBDA304\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '添加委派管理员账号', + 'summary' => '调用RegisterDelegatedAdministrator将资源目录的成员账号设置为可信服务的委派管理员账号。', + 'description' => '设置完成后，委派管理员账号将获得访问资源目录组织信息的授权，从而具有了对组织成员和结构的可见性。委派管理员账号在指定可信服务中将代表企业管理账号执行服务相关管理操作。'."\n" + .'使用限制：'."\n" + .'- 只有部分可信服务支持委派管理员功能。更多信息，请参见[支持的可信服务](~~208133~~)。'."\n" + .'- 只有资源目录的企业管理账号及其下被授权的RAM用户和RAM角色才能调用该API。'."\n" + .'- 可信服务允许添加的委派管理员账号数量由各可信服务定义。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeregisterDelegatedAdministrator' => [ + 'summary' => '调用DeregisterDelegatedAdministrator移除可信服务的委派管理员账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录中的成员账号UID。', + 'type' => 'string', + 'required' => true, + 'example' => '181761095690****', + ], + ], + [ + 'name' => 'ServicePrincipal', + 'in' => 'query', + 'schema' => [ + 'description' => '可信服务的标识。'."\n" + ."\n" + .'具体信息，请参见[支持的可信服务](~~208133~~)中的`可信服务标识`列。', + 'type' => 'string', + 'required' => true, + 'example' => 'cloudfw.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\tDF5D5C52-7BD0-40E7-94C6-23A1505038A2\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '移除委派管理员账号', + 'description' => '> 如果被移除的委派管理账号在可信服务中存在历史管理任务，移除操作可能对可信服务的正常使用产生影响。请在移除前慎重考虑可能产生的影响，然后再进行移除操作。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDelegatedAdministrators' => [ + 'summary' => '调用ListDelegatedAdministrators查询可信服务的委派管理员账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ServicePrincipal', + 'in' => 'query', + 'schema' => [ + 'description' => '可信服务的标识。'."\n" + ."\n" + .'具体信息，请参见[支持的可信服务](~~208133~~)中的`可信服务标识`列。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloudfw.aliyuncs.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '009C3A02-7D4B-416C-9CE7-548C91508F1E', + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '委派管理员账号信息。', + 'type' => 'array', + 'items' => [ + 'description' => '账号信息', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '成员UID。', + 'type' => 'string', + 'example' => '138660628348****', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。取值：'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ServicePrincipal' => [ + 'description' => '可信服务的标识。', + 'type' => 'string', + 'example' => 'cloudfw.aliyuncs.com', + ], + 'DelegationEnabledTime' => [ + 'description' => '设置为委派管理员账号的时间戳。', + '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":"\\r\\n\\r\\n\\t009C3A02-7D4B-416C-9CE7-548C91508F1E\\r\\n\\t2\\r\\n\\t10\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1616652684164\\r\\n\\t\\t\\tcreated\\r\\n\\t\\t\\t138660628348****\\r\\n\\t\\t\\tcloudfw.aliyuncs.com\\r\\n\\t\\t\\tabc\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1616489836069\\r\\n\\t\\t\\tinvited\\r\\n\\t\\t\\t177242285274****\\r\\n\\t\\t\\tcloudfw.aliyuncs.com\\r\\n\\t\\t\\ttest\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询可信服务的委派管理员账号', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDelegatedServicesForAccount' => [ + 'summary' => '调用ListDelegatedServicesForAccount查询指定成员被设置为哪些可信服务的委派管理员账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。', + 'type' => 'string', + 'required' => true, + 'example' => '138660628348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D9C03B94-9396-4794-A74B-13DC437556A6', + ], + 'DelegatedServices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DelegatedService' => [ + 'description' => '可信服务列表。'."\n" + ."\n" + .'> 如果返回为空，则表示查询的成员不是委派管理员账号。', + 'type' => 'array', + 'items' => [ + 'description' => '可信服务信列表。'."\n" + ."\n" + .'> 如果返回为空，则表示查询的成员不是委派管理员账号。', + 'type' => 'object', + 'properties' => [ + 'DelegationEnabledTime' => [ + 'description' => '设置为委派管理员账号的时间戳。', + 'type' => 'string', + 'example' => '1616652684164', + ], + 'ServicePrincipal' => [ + 'description' => '可信服务的标识。', + 'type' => 'string', + 'example' => 'cloudfw.aliyuncs.com', + ], + 'Status' => [ + 'description' => '可信服务的启用状态。取值：'."\n" + ."\n" + .'- ENABLED：已启用。'."\n" + .'- DISABLED：未启用。', + '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":"\\n D9C03B94-9396-4794-A74B-13DC437556A6\\n \\n \\n ENABLED\\n 1616652684164\\n cloudfw.aliyuncs.com\\n \\n \\n","errorExample":""}]', + 'title' => '查询指定成员账号是否为委派管理员账号', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateResourceGroup' => [ + 'summary' => '调用CreateResourceGroup创建资源组。', + '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' => '资源组唯一标识。'."\n" + ."\n" + .'长度为2~50个字符，可包含英文字母、数字和短划线（-）。必须以英文字母开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组显示名称。'."\n" + ."\n" + .'长度为1~50个字符或汉字。', + 'type' => 'string', + 'required' => true, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ResourceGroup' => [ + 'description' => '资源组信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => '151266687691****', + ], + 'CreateDate' => [ + 'description' => '资源组创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-06-05T14:39:13+08:00', + ], + 'DisplayName' => [ + 'description' => '资源组显示名称。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'description' => '各个地域的资源组状态。', + 'type' => 'array', + 'items' => [ + 'description' => '各个地域的资源组状态。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。', + 'type' => 'string', + 'example' => 'Creating', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。', + '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":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\tCreating\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tap-northeast-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tap-south-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tap-southeast-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tap-southeast-2\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tap-southeast-3\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tap-southeast-5\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-beijing\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-chengdu\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-guangzhou\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-hangzhou-cloudstone\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-hangzhou-test-306\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-heyuan\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-hongkong\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-huhehaote\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-north-2-gov-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-qingdao\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-shanghai\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-shanghai-finance-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-shenzhen\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-shenzhen-finance-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-wulanchabu\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tcn-zhangjiakou\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\teu-central-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\teu-west-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tme-east-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\trus-west-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tus-east-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCreating\\r\\n\\t\\t\\t\\tus-west-1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t151266687691****\\r\\n\\t\\tmy-project\\r\\n\\t\\trg-9gLOoK****\\r\\n\\t\\t2021-06-05T14:39:13+08:00\\r\\n\\t\\tmy-project\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建资源组', + 'description' => '> 一个阿里云账号下最多创建30个资源组。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以调用[ListResourceGroups](~~158855~~)查询资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01', + ], + 'ResourceGroup' => [ + 'description' => '资源组信息。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '资源组显示名称。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。', + 'type' => 'string', + 'example' => 'PendingDelete', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'description' => '各个地域的资源组状态。', + 'type' => 'array', + 'items' => [ + 'description' => '各个地域的资源组状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。'."\n" + .'- Deleting：删除中。', + 'type' => 'string', + 'example' => 'PendingDelete', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + ], + ], + ], + ], + ], + 'AccountId' => [ + 'description' => '资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => '123456789****', + ], + 'Name' => [ + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'CreateDate' => [ + 'description' => '资源组创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Id' => [ + 'description' => '资源组ID。', + '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":"\\r\\n\\r\\n\\t1C488B66-B819-4D14-8711-C4EAAA13AC01\\r\\n\\t\\r\\n\\t\\trg-9gLOoK****\\r\\n\\t\\t123456789****\\r\\n\\t\\tmy-project\\r\\n\\t\\tmy-project\\r\\n\\t\\tPendingDelete\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\tPendingDelete\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcn-qingdao\\r\\n\\t\\t\\t\\tPendingDelete\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '删除资源组', + 'summary' => '调用DeleteResourceGroup删除资源组。', + 'description' => '> 删除资源组前，请先删除资源组中的资源。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以调用[ListResourceGroups](~~158855~~)获取资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'NewDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组显示名称。'."\n" + ."\n" + .'长度为1~50个字符或汉字。', + 'type' => 'string', + 'required' => true, + 'example' => 'project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ResourceGroup' => [ + 'description' => '资源组信息。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '资源组显示名称。', + 'type' => 'string', + 'example' => 'project', + ], + 'AccountId' => [ + 'description' => '资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => '123456789****', + ], + 'Name' => [ + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'CreateDate' => [ + 'description' => '资源组创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18+08:00', + ], + 'Id' => [ + 'description' => '资源组ID。', + '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":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\trg-9gLOoK****\\r\\n\\t\\t123456789****\\r\\n\\t\\tmy-project\\r\\n\\t\\tproject\\r\\n\\t\\t2015-01-23T12:33:18+08:00\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '修改资源组的显示名称', + 'summary' => '调用UpdateResourceGroup修改资源组的显示名称。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResourceGroups' => [ + 'summary' => '调用ListResourceGroups查询资源组列表。', + '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' => '资源组状态，用于查询的过滤条件。取值：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，用于查询的过滤条件。'."\n" + ."\n" + .'长度不能超过18个字符，且以`rg-`开头。'."\n" + ."\n" + .'> 该参数已被收编到参数`ResourceGroupIds`，如果您同时设置了`ResourceGroupId`和`ResourceGroupIds`，则会以`ResourceGroupIds`为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资源组显示名称，用于查询的过滤条件。支持模糊查询。'."\n" + ."\n" + .'长度不能超过50个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组唯一标识，用于查询的过滤条件。支持模糊查询。'."\n" + ."\n" + .'长度不能超过50个字符，可包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'my-project', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签，用于查询的过滤条件。'."\n" + ."\n" + .'最多可以设置20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签，用于查询的过滤条件。'."\n" + ."\n" + .'最多可以设置20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回标签信息。取值：'."\n" + ."\n" + .'- false（默认值）：不返回。'."\n" + ."\n" + .'- true：返回。'."\n" + .'> 当您设置了标签过滤条件后，不论`IncludeTags`为何值，都会返回标签信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源组ID列表，用于查询的过滤条件。'."\n" + ."\n" + .'最多可以设置100个资源组ID。'."\n" + ."\n" + .'> 如果您同时设置了`ResourceGroupId`和`ResourceGroupIds`，则会以`ResourceGroupIds`为准。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID列表，用于查询的过滤条件。'."\n" + ."\n" + .'最多可以设置100个资源组ID。'."\n" + ."\n" + .'> 如果您同时设置了`ResourceGroupId`和`ResourceGroupIds`，则会以`ResourceGroupIds`为准。', + 'type' => 'string', + 'required' => false, + 'example' => '{"rg-1hSBH2****","rg-9gLOoK****"}', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E', + ], + 'ResourceGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourceGroup' => [ + 'description' => '资源组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组列表。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => '123456789****', + ], + 'CreateDate' => [ + 'description' => '资源组创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DisplayName' => [ + 'description' => '资源组显示名称。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '符合请求参数条件的数据总条数。', + '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":"\\n 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\n 1\\n 10\\n 2\\n \\n \\n rg-1hSBH2****\\n 123456789****\\n default\\n 默认资源组\\n OK\\n 2015-01-23T12:33:18Z\\n \\n \\n k1\\n v1\\n \\n \\n \\n \\n rg-9gLOoK****\\n 123456789****\\n my-project\\n my-project\\n OK\\n 2015-01-23T12:33:18Z\\n \\n \\n k2\\n v2\\n \\n \\n \\n \\n","errorExample":""}]', + 'title' => '查询资源组列表', + 'description' => '您可以调用本API查询当前账号下的所有资源组列表，也可以根据资源组状态、资源组ID、资源组标识或资源组显示名称查询对应的资源组列表。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResources' => [ + 'summary' => '调用ListResources查询当前账号可以访问的资源组中的资源列表。', + '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' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-uPJpP****', + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-23v38****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源类型列表。最多支持50组。'."\n" + ."\n" + .'> 如果您设置了`ResourceTypes`，则请求参数中单独设置的`Service`和`ResourceType`将不生效。', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'N的取值范围：1~50。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。'."\n" + .'> `ResourceTypes`中的`Service`和`ResourceType`参数必须同时设置，否则将不生效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'N的取值范围：1~50。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。'."\n" + .'> `ResourceTypes`中的`Service`和`ResourceType`参数必须同时设置，否则将不生效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '资源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '资源创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-uPJpP****', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-23v38****', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + '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":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t1\\r\\n\\t10\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\trg-uPJpP****\\r\\n\\t\\t\\tecs\\r\\n\\t\\t\\tinstance\\r\\n\\t\\t\\ti-23v38****\\r\\n\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t","errorExample":""}]', + 'title' => '查看当前账号可以访问的资源列表', + 'description' => '> 该API支持通过RAM角色方式调用，但不支持角色的会话策略。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetResourceGroup' => [ + 'summary' => '调用GetResourceGroup查询资源组信息。', + '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' => '资源组ID。'."\n" + ."\n" + .'您可以调用[ListResourceGroups](~~158855~~)查询资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回标签信息。取值：'."\n" + ."\n" + .'- false（默认值）：不返回。'."\n" + .'- true：返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + 'ResourceGroup' => [ + 'description' => '资源组信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => '123456789****', + ], + 'CreateDate' => [ + 'description' => '资源组创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DisplayName' => [ + 'description' => '资源组显示名称。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'RegionStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionStatus' => [ + 'description' => '各个地域的资源组状态。', + 'type' => 'array', + 'items' => [ + 'description' => '各个地域的资源组状态。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。'."\n" + .'- Deleting：删除中。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => '标签值。', + '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":"\\n 2D69A58F-345C-4FDE-88E4-BF5189484043\\n \\n rg-9gLOoK****\\n 123456789****\\n my-project\\n my-project\\n OK\\n \\n \\n cn-hangzhou\\n OK\\n \\n \\n cn-qingdao\\n OK\\n \\n \\n 2015-01-23T12:33:18Z\\n \\n \\n k1\\n v1\\n \\n \\n \\n","errorExample":""}]', + 'title' => '查询资源组信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MoveResources' => [ + 'summary' => '调用MoveResources将资源从一个资源组转移到另一个资源组。', + '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' => '将要转入的目标资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekzmeobk5w****', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '将要转移的资源列表。'."\n" + ."\n" + .'> 每次最多转移10个资源。多个资源请分批转移。', + 'type' => 'array', + 'items' => [ + 'description' => '将要转移的资源列表。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-23v38****', + ], + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C00B89D3-3247-11DE-95D8-A7C01FB0AB4F', + ], + 'Responses' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => '错误代码。'."\n" + ."\n" + .'> 资源转移失败时返回该参数。', + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'ErrorMsg' => [ + 'description' => '错误信息。'."\n" + .'> 资源转移失败时返回该参数。', + 'type' => 'string', + 'example' => '没权限', + ], + 'RegionId' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C00B89D3-3247-11DE-95D8-A7C01FB0AB4F', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-23v38****', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- SUCCESS：成功。'."\n" + .'- FAIL：失败。', + '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":"\\n C00B89D3-3247-11DE-95D8-A7C01FB0AB4F\\n \\n ecs\\n i-23v38****\\n instance\\n C00B89D3-3247-11DE-95D8-A7C01FB0AB4F\\n SUCCESS\\n \\n \\n cn-hangzhou\\n \\n","errorExample":""}]', + 'title' => '资源转组', + 'description' => '支持跨地域、跨云服务、跨资源组批量转移资源。'."\n" + ."\n" + .'支持转移资源组的云服务，请参见[支持资源组的云服务](~~94479~~)的**API**列。', + ], + 'EnableAutoGrouping' => [ + 'summary' => '调用EnableAutoGrouping开通自动转组。开通后可以创建、更新、删除、查询自动转组规则。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '开通自动转组', + ], + 'DisableAutoGrouping' => [ + 'summary' => '调用DisableAutoGrouping关闭自动转组。关闭自动转组功能后，已设置的自定义条件规则、关联资源跟随转组规则将会被删除，存量资源所属资源组不受影响。如您需要，您也可以在关闭自动转组功能1分钟后，重新开启该功能。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '关闭自动转组', + ], + 'UpdateAutoGroupingConfig' => [ + 'summary' => '调用UpdateAutoGroupingConfig更新自动转组设置。目前仅支持设置是否开启存量关联资源跟随转组任务。', + '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' => '是否开启存量关联资源跟随转组任务。取值：'."\n" + ."\n" + .'- false：不开启存量关联资源跟随转组任务。'."\n" + .'- true：开启存量关联资源跟随转组任务。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '更新自动转组设置', + ], + 'GetAutoGroupingStatus' => [ + 'summary' => '调用GetAutoGroupingStatus查询自动转组设置状态。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EnableExistedResourcesTransfer' => [ + 'description' => '存量资源关联转组是否开启。取值：'."\n" + .'- true：已开启。'."\n" + .'- false：未开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableStatus' => [ + 'description' => '自动转组开通状态。取值：'."\n" + .'- Enabling：开通中。'."\n" + .'- Enable：已开通。'."\n" + .'- Partial_Enable：关联资源跟随转组已开通，自定义条件转组未开通。如需要开通自定义条件转组，请调用[EnableAutoGrouping](~~EnableAutoGrouping~~)。'."\n" + .'- Disable：未开通。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '查询自动转组状态', + ], + 'CreateAutoGroupingRule' => [ + 'summary' => '调用CreateAutoGroupingRule创建自动转组规则。支持自定义转组规则和关联资源跟随转组规则两类。', + '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' => '规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'A项目线上资源自动转组规则', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'RuleDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'required' => false, + 'example' => '带有标签 {"env": "online"} 和 {"project": "A"} 的资源转移到资源组 rg-aek2********qcy', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- custom_condition：自定义转组规则。'."\n" + .'- associated_transfer：关联资源跟随转组规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'custom_condition', + 'enum' => [ + 'associated_transfer', + 'custom_condition', + ], + ], + ], + [ + 'name' => 'RuleContents', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则内容。', + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => '自动转组范围条件，用于指定需要自动转组的资源范围。', + 'type' => 'string', + 'required' => false, + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + 'maxLength' => 50000, + ], + 'TargetResourceGroupCondition' => [ + 'description' => '目标资源组条件，用于指定自动分组的目标资源组。', + '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' => '资源组ID范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq', + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'ExcludeResourceGroupIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID排除范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******zj2oi,rg-aekz******r62ua', + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'RegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou,cn-shanghai', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeRegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID排除范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing,cn-guangzhou', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ExcludeResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID排除范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-uf6p******4h784y,rmq-cn-******ny0y', + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds.dbinstance,oss.bucket', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型排除范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'mse.cluster,slb.loadbalancer', + 'maxLength' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F7701451-340B-5CB3-AEA7-7D831F7F38C0', + ], + 'RuleId' => [ + 'description' => '规则ID。', + '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' => '创建自动转组规则', + 'description' => '自定义转组规则最多创建10个，每个自定义转组规则支持最多10条规则内容。', + 'requestParamsDescription' => '### 示例1：根据资源标签自动转组'."\n" + .'```'."\n" + .'{'."\n" + .' "RuleName": "A项目线上资源自动转组",'."\n" + .' "RuleDesc": "带有标签 {\\"env\\": \\"online\\"} 和 {\\"project\\": \\"A\\"} 的资源转移到资源组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" + ."\n\n" + .'### 示例2：云盘跟随ECS实例转组'."\n" + .'```'."\n" + .'{'."\n" + .' "RuleName": "云盘跟随ECS实例转组",'."\n" + .' "RuleDesc": "当云盘挂载到ECS实例或ECS实例转组时，与之关联的云盘将自动转入关联ECS实例所在的资源组",'."\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' => '调用DeleteAutoGroupingRule删除自动转组规则。', + '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' => '规则ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfo******hy6a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '删除自动转组规则', + ], + 'UpdateAutoGroupingRule' => [ + 'summary' => '调用UpdateAutoGroupingRule更新自动转组规则。', + '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' => '规则ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfo******hy6a', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'A项目线上资源自动转组规则', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'RuleDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'required' => false, + 'example' => '带有标签 {"env": "online"} 和 {"project": "A"} 的资源转移到资源组rg-aek2********qcy', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'RuleContents', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则内容。', + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => '自动转组范围条件，用于指定需要自动转组的资源范围。', + 'type' => 'string', + 'required' => false, + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + 'maxLength' => 50000, + ], + 'RuleContentId' => [ + 'description' => '规则内容ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'grc-acfo******fwybpq', + ], + 'TargetResourceGroupCondition' => [ + 'description' => '目标资源组条件，用于指定自动转组的目标资源组。', + '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' => '资源组ID范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq'."\n", + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'ExcludeResourceGroupIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID排除范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz******zj2oi,rg-aekz******r62ua'."\n", + 'maxLength' => 8000, + ], + ], + [ + 'name' => 'RegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou,cn-shanghai'."\n", + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeRegionIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID排除范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing,cn-guangzhou'."\n", + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a'."\n", + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ExcludeResourceIdsScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID排除范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-uf6p******4h784y,rmq-cn-******ny0y', + 'maxLength' => 5000, + ], + ], + [ + 'name' => 'ResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds.dbinstance,oss.bucket', + 'maxLength' => 2000, + ], + ], + [ + 'name' => 'ExcludeResourceTypesScope', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型排除范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'mse.cluster,slb.loadbalancer', + 'maxLength' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '更新自动转组规则', + ], + 'ListAutoGroupingRules' => [ + 'summary' => '调用ListAutoGroupingRules查询自动转组规则列表。', + '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' => '规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gr-acfo******hy6a', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'A项目线上资源自动转组规则', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- custom_condition：自定义规则转组。'."\n" + .'- associated_transfer：关联资源跟随转组。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom_condition'."\n", + 'enum' => [ + 'associated_transfer', + 'custom_condition', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '单次请求返回结果的最大条数。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'MaxResults' => [ + 'description' => '单次请求返回结果的最大条数。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Rules' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则列表。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '规则创建时间。', + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'ExcludeRegionIdsScope' => [ + 'description' => '地域ID排除范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai', + ], + 'ExcludeResourceGroupIdsScope' => [ + 'description' => '资源组ID排除范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'rg-aekz****ql4b5ea,rg-aek2****akfxykq', + ], + 'ExcludeResourceIdsScope' => [ + 'description' => '资源ID排除范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + ], + 'ExcludeResourceTypesScope' => [ + 'description' => '资源类型排除范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc', + ], + 'ModifyTime' => [ + 'description' => '规则更新时间。', + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'RegionIdsScope' => [ + 'description' => '地域ID范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai', + ], + 'ResourceGroupIdsScope' => [ + 'description' => '资源组ID范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'rg-aekz****ql4b5ea,rg-aek2****akfxykq', + ], + 'ResourceIdsScope' => [ + 'description' => '资源ID范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + ], + 'ResourceTypesScope' => [ + 'description' => '资源类型范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc', + ], + 'RuleContents' => [ + 'description' => '规则内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则内容列表。', + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => '自动转组范围条件，用于指定需要自动转组的资源范围。', + 'type' => 'string', + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + ], + 'RuleContentId' => [ + 'description' => '规则内容ID。', + 'type' => 'string', + 'example' => 'grc-acfo******fwybpq', + ], + 'TargetResourceGroupCondition' => [ + 'description' => '目标资源组条件，用于指定自动分组的目标资源组。', + 'type' => 'string', + 'example' => '{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}', + ], + ], + ], + ], + 'RuleDesc' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => '带有标签 {"env": "online"} 和 {"project": "A"} 的资源转移到资源组rg-aek2********qcy', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => 'gr-acfo******hy6a'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'A项目线上资源自动转组规则', + ], + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + .'- custom_condition：自定义规则转组。'."\n" + .'- associated_transfer：关联资源跟随转组。', + 'type' => 'string', + 'example' => 'custom_condition', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '查询自动转组规则列表', + ], + 'GetAutoGroupingRule' => [ + 'summary' => '调用GetAutoGroupingRule查询自动转组规则信息。', + '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' => '规则ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfo******hy6a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '规则创建时间。', + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'ExcludeRegionIdsScope' => [ + 'description' => '地域ID排除范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai', + ], + 'ExcludeResourceGroupIdsScope' => [ + 'description' => '资源组ID排除范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq', + ], + 'ExcludeResourceIdsScope' => [ + 'description' => '资源ID排除范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + ], + 'ExcludeResourceTypesScope' => [ + 'description' => '资源类型排除范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc', + ], + 'ModifyTime' => [ + 'description' => '规则修改时间。', + 'type' => 'string', + 'example' => '2025-01-01T10:00:00+08:00', + ], + 'RegionIdsScope' => [ + 'description' => '地域ID范围，多个地域ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'cn-hangzhou,cn-shanghai', + ], + 'ResourceGroupIdsScope' => [ + 'description' => '资源组ID范围，多个资源组ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'rg-aekz******4b5ea,rg-aek2******fxykq', + ], + 'ResourceIdsScope' => [ + 'description' => '资源ID范围，多个资源ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a', + ], + 'ResourceTypesScope' => [ + 'description' => '资源类型范围，多个资源类型用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'ecs.instance,vpc.vpc', + ], + 'RuleContents' => [ + 'description' => '规则内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则内容列表。', + 'type' => 'object', + 'properties' => [ + 'AutoGroupingScopeCondition' => [ + 'description' => '自动转组范围条件，用于指定需要自动转组的资源范围。', + 'type' => 'string', + 'example' => '{"children":[{"desired":"{\\"env\\":\\"online\\", \\"project\\":\\"A\\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}', + ], + 'RuleContentId' => [ + 'description' => '规则内容ID。', + 'type' => 'string', + 'example' => 'grc-acfo******fwybpq', + ], + 'TargetResourceGroupCondition' => [ + 'description' => '目标资源组条件，用于指定自动分组的目标资源组。', + 'type' => 'string', + 'example' => '{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}', + ], + ], + ], + ], + 'RuleDesc' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => '带有标签 {"env": "online"} 和 {"project": "A"} 的资源转移到资源组rg-aek2********qcy', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => 'gr-acfo******hy6a', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'A项目线上资源自动转组规则', + ], + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + .'- custom_condition：自定义规则转组。'."\n" + .'- associated_transfer：关联资源跟随转组。', + 'type' => 'string', + 'example' => 'associated_transfer', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '查询自动转组规则信息', + ], + 'EnableAssociatedTransfer' => [ + 'summary' => '调用EnableAssociatedTransfer开通关联资源跟随转组功能。', + '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' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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":"\\n 2D69A58F-345C-4FDE-88E4-BF5189484114\\n","errorExample":""}]', + 'title' => '开通关联资源跟随转组功能', + ], + 'DisableAssociatedTransfer' => [ + 'summary' => '调用DisableAssociatedTransfer关闭关联资源跟随转组功能。', + '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' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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":"\\n 7CE0AE54-6F27-5522-A429-4C5EE8FD40C8\\n","errorExample":""}]', + 'title' => '关闭关联资源跟随转组功能', + ], + 'UpdateAssociatedTransferSetting' => [ + 'summary' => '调用UpdateAssociatedTransferSetting更新关联转组功能设置。', + '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' => '关联转组功能规则设置。', + 'type' => 'array', + 'items' => [ + 'description' => '关联转组功能规则设置。', + 'type' => 'object', + 'properties' => [ + 'AssociatedResourceType' => [ + 'description' => '关联资源的资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'disk', + ], + 'AssociatedService' => [ + 'description' => '关联资源的云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取云服务代码。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'MasterResourceType' => [ + 'description' => '主资源的资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'MasterService' => [ + 'description' => '主资源的云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取云服务代码。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Status' => [ + 'description' => '关联转组功能开通状态。取值：'."\n" + ."\n" + .'- Enable：开启。'."\n" + .'- Disable：关闭。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableExistingResourcesTransfer', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启动存量关联资源跟随转组任务。取值：'."\n" + ."\n" + .'- false：不启动存量关联资源跟随转组任务。'."\n" + .'- true：启动存量关联资源跟随转组任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n","errorExample":""}]', + 'title' => '更新关联转组功能设置', + 'description' => '支持关联资源跟随转组的云资源，请参见[关联资源跟随转组](~~606232~~)。', + ], + 'ListAssociatedTransferSetting' => [ + 'summary' => '调用ListAssociatedTransferSetting获取关联转组功能设置。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AssociatedTransferSetting' => [ + 'description' => '关联转组功能设置。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '阿里云账号（主账号）ID。', + 'type' => 'string', + 'example' => '121998723923****', + ], + 'EnableExistingResourcesTransfer' => [ + 'description' => '是否启动存量关联资源跟随转组任务。取值：'."\n" + ."\n" + .'- false：不启动存量关联资源跟随转组任务。'."\n" + .'- true：启动存量关联资源跟随转组任务。', + 'type' => 'string', + 'example' => 'true', + ], + 'RuleSettings' => [ + 'description' => '关联转组功能规则设置。', + 'type' => 'array', + 'items' => [ + 'description' => '关联转组功能规则设置。', + 'type' => 'object', + 'properties' => [ + 'AssociatedResourceType' => [ + 'description' => '关联资源的资源类型。', + 'type' => 'string', + 'example' => 'disk', + ], + 'AssociatedService' => [ + 'description' => '关联资源的云服务代码。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'MasterResourceType' => [ + 'description' => '主资源的资源类型。', + 'type' => 'string', + 'example' => 'instance', + ], + 'MasterService' => [ + 'description' => '主资源的云服务代码。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'Status' => [ + 'description' => '关联转组功能开通状态。取值：'."\n" + ."\n" + .'- Enable：开启。'."\n" + .'- Disable：关闭。', + 'type' => 'string', + 'example' => 'Enable', + ], + ], + ], + ], + 'Status' => [ + 'description' => '关联转组功能开通状态。取值：'."\n" + ."\n" + .'- Enable：开启。'."\n" + .'- Disable：关闭。', + 'type' => 'string', + 'example' => 'Enable', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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":"\\n 7556FD65-45D2-5C45-9FC9-A7DE831C775C\\n \\n 121998723923****\\n Enable\\n \\n disk\\n instance\\n ecs\\n ecs\\n Enable\\n \\n true\\n \\n","errorExample":""}]', + 'title' => '获取关联转组功能设置', + ], + 'GetResourceGroupResourceCounts' => [ + 'summary' => '查询可见资源组下的资源数量。', + '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' => '资源类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型。', + 'type' => 'object', + 'properties' => [ + 'ResourceTypeCode' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'GroupByKey', + 'in' => 'query', + 'schema' => [ + 'description' => '资源数量统计的分组维度。'."\n" + .'> 请指定一个分组维度，不指定时返回结果将为空。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ResourceGroupId' => '按资源组维度统计资源数量', + 'ResourceType' => '按资源类型维度统计资源数量', + ], + 'example' => 'ResourceGroupId', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以调用[ListResourceGroups](~~2716558~~)获取资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + 'ResourceCounts' => [ + 'description' => '资源数量。', + 'type' => 'array', + 'items' => [ + 'description' => '资源数量。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '资源数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GroupByKey' => [ + 'description' => '资源数量统计的分组维度。', + 'type' => 'string', + 'example' => 'ResourceGroupId', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + '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' => '查询可见资源组资源数量', + ], + 'ListAutoGroupingRemediations' => [ + 'summary' => '调用ListAutoGroupingRemediations列出自动分组修正记录。', + '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' => '标记当前开始读取的位置，置空表示从头开始', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '本次读取的最大数据记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gr-acfnugygwms32yy', + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务ID。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务编码**列获取云服务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-23v38****', + ], + ], + [ + 'name' => 'TargetResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '修正目标资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz26emqhc****', + ], + ], + [ + 'name' => 'EarliestRemediationTime', + 'in' => 'query', + 'schema' => [ + 'description' => '最早时间，默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01 00:00:00', + ], + ], + [ + 'name' => 'LatestRemediationTime', + 'in' => 'query', + 'schema' => [ + 'description' => '最晚时间，默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-01 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始的Token。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'Remediations' => [ + 'description' => '修正记录。', + 'type' => 'array', + 'items' => [ + 'description' => '修正记录。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'RemediationId' => [ + 'description' => '修正记录ID。', + 'type' => 'string', + 'example' => '0028d4****cfe94956ef6708a373f396fbc840e306f', + ], + 'RemediationTime' => [ + 'description' => '修正时间。', + 'type' => 'string', + 'example' => '2022-01-01 00:00:00', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-uf664f66v1****drkea4', + ], + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务ID。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务编码**列获取云服务ID。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'TargetResourceGroupInfo' => [ + 'description' => '修正目标资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupDisplayName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'ProjectA', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmygrk****wfa', + ], + ], + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '列出自动分组修正记录', + ], + 'GetResourceGroupAdminSetting' => [ + 'summary' => '调用GetResourceGroupAdminSetting查询资源组管理员配置。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'CreatorAsAdmin' => [ + 'description' => '资源组创建者设置为资源组管理员。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '查询资源组管理员配置', + ], + 'UpdateResourceGroupAdminSetting' => [ + 'summary' => '调用UpdateResourceGroupAdminSetting更新资源组管理员配置。', + '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' => '资源组创建者设置为资源组管理员。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '更新资源组管理员配置', + ], + 'LookupResourceGroupEvents' => [ + 'summary' => '查询资源组事件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '事件开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-30 23:43:16', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '事件结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-30 23:43:16', + ], + ], + [ + 'name' => 'EventCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'MemberShipChange', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始的Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'LookupAttributes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '检索属性。', + 'type' => 'array', + 'items' => [ + 'description' => '检索属性。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '检索属性key。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => '检索属性value。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ProjectA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Events' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件列表。', + 'type' => 'object', + 'properties' => [ + 'ChangeType' => [ + 'description' => '事件变更类型。', + 'type' => 'string', + 'example' => 'Add', + ], + 'EventTime' => [ + 'description' => '事件时间。', + 'type' => 'string', + 'example' => '2025-12-04T18:35:17Z', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'ResourceGroupDisplayName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'ProjectA', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfm2sohr74****', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-wz9fpfe64****', + ], + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'SourceResourceGroupInfo' => [ + 'description' => '源资源组。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupDisplayName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'TestGroupA', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekz25pfurj****', + ], + ], + ], + 'TargetResourceGroupInfo' => [ + 'description' => '目标资源组。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupDisplayName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'TestGroupB', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmwfrxcre****', + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '下一个查询开始Token', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '查询资源组事件', + ], + 'EnableResourceGroupNotification' => [ + 'summary' => '调用EnableResourceGroupNotification开通组事件通知。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '开通组事件通知', + ], + 'DisableResourceGroupNotification' => [ + 'summary' => '调用DisableResourceGroupNotification关闭组事件通知。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '关闭资源组通知', + ], + 'GetResourceGroupNotificationSetting' => [ + 'summary' => '调用GetResourceGroupNotificationSetting查询资源组通知设置。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F70D09B-0EE5-54A6-A09A-1EBDB9297172', + ], + 'ResourceGroupNotificationEnableStatus' => [ + 'description' => '是否开启组事件通知。', + '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' => '查看组事件通知设置', + ], + 'ListResourceGroupCapability' => [ + 'summary' => '列出资源组能力项。', + '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' => '云服务ID。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取云服务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'SupportResourceGroupEvent', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持资源组事件', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'Capabilities' => [ + 'description' => '能力项列表', + 'type' => 'array', + 'items' => [ + 'description' => '能力项', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'SupportResourceGroupEvent' => [ + 'description' => '是否支持资源组事件', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + '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' => '列出资源组能力项', + ], + 'ListResourceGroupsWithAuthDetails' => [ + 'summary' => '调用ListResourceGroupsWithAuthDetails列出资源组与用户授权信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组状态，用于查询的过滤条件。取值：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组显示名称，用于查询的过滤条件。支持模糊查询。'."\n" + ."\n" + .'长度不能超过50个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestRG-BVT1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组唯一标识，用于查询的过滤条件。支持模糊查询。'."\n" + ."\n" + .'长度不能超过50个字符，可包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod-rg', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncludeTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回标签信息。取值：'."\n" + ."\n" + .'- false（默认值）：不返回。'."\n" + ."\n" + .'- true：返回。'."\n" + .'> 当您设置了标签过滤条件后，不论`IncludeTags`为何值，都会返回标签信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3uwewyefzuy', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceTypeCode' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务代码。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务代码**列获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AuthDetails' => [ + 'description' => '接口返回资源组的授权详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接口返回资源组的授权详情。', + 'type' => 'object', + 'properties' => [ + 'AccountScopeAuth' => [ + 'description' => '用户在该资源类型下是否有账号级授权。', + 'type' => 'boolean', + ], + 'AuthOfResourceGroups' => [ + 'description' => '资源组在资源类型上是否有权限。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组在资源类型上是否有权限。', + 'type' => 'object', + 'properties' => [ + 'HasPermission' => [ + 'description' => '是否有权限。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekzscexx6w3u2y', + ], + ], + ], + ], + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**资源类型**列获取。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Service' => [ + 'description' => '云服务ID。'."\n" + ."\n" + .'您可以从[支持资源组的云服务](~~94479~~)的**云服务编码**列获取云服务ID。', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果。', + 'type' => 'string', + 'example' => '4141780B-4E3D-5D2A-A8F4-44D6D34F****', + ], + 'ResourceGroups' => [ + 'description' => '资源组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => '123456789****', + ], + 'CreateDate' => [ + 'description' => '资源组创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DisplayName' => [ + 'description' => '资源组显示名称。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + 'Name' => [ + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'my-project', + ], + 'Status' => [ + 'description' => '资源组状态。取值：'."\n" + .'- Creating：创建中。'."\n" + .'- OK：创建成功。'."\n" + .'- PendingDelete：等待删除。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总条数。', + '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' => '列出资源组与用户授权信息', + ], + 'CreateRole' => [ + 'summary' => '调用CreateRole创建角色。', + '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' => '角色名称。'."\n" + ."\n" + .'长度为1~64个字符，可包含英文字母、数字、点号（.）和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '角色描述。'."\n" + ."\n" + .'长度为1~1024个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS管理角色', + ], + ], + [ + 'name' => 'AssumeRolePolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '扮演角色的权限策略内容。'."\n" + ."\n" + .'指定允许扮演该角色的一个或多个主体，这个主体可以是阿里云账号、阿里云服务或身份提供商。'."\n" + ."\n" + .'> RAM用户不能扮演可信实体为阿里云服务的RAM角色。 ', + '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' => '角色最大会话时间。'."\n" + ."\n" + .'取值范围：3600秒~43200秒。默认值：3600秒。'."\n" + ."\n" + .'取值为空时将采用默认值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Role' => [ + 'description' => '角色信息。', + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => '角色的资源描述符。', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => '扮演角色的权限策略内容。', + 'type' => 'string', + 'example' => '{ \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::12345678901234****:root\\" } } ], \\"Version\\": \\"1\\" }', + ], + 'CreateDate' => [ + 'description' => '角色创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => '角色描述。', + 'type' => 'string', + 'example' => 'ECS管理角色', + ], + 'MaxSessionDuration' => [ + 'description' => '角色最大会话时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => '角色ID。', + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => '被授权角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin@role.123456.onaliyunservice.com', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"ECSAdmin@role.123456.onaliyunservice.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\t90123456789****\\r\\n\\t\\tECSAdmin\\r\\n\\t\\tECSAdmin@role.123456.onaliyunservice.com\\r\\n\\t\\tacs:ram::123456789012****:role/ECSAdmin\\r\\n\\t\\tECS管理角色\\r\\n\\t\\t3600\\r\\n\\t\\t{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建角色', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRole' => [ + 'summary' => '调用DeleteRole删除角色。', + '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' => '角色名称。'."\n" + ."\n" + .'长度为1~64个字符，可包含英文字母、数字、点号（.）和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '898FAB24-7509-43EE-A287-086FE4C44394', + ], + ], + ], + ], + ], + '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":"\\r\\n\\r\\n 898FAB24-7509-43EE-A287-086FE4C44394\\r\\n","errorExample":""}]', + 'title' => '删除角色', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateRole' => [ + 'summary' => '调用UpdateRole更新RAM角色信息。', + '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' => 'RAM角色名称。'."\n" + ."\n" + .'长度为1~64个字符，可包含英文字母、数字、半角句号（.）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + [ + 'name' => 'NewAssumeRolePolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => 'RAM角色的信任策略。', + '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' => 'RAM角色最大会话时间。'."\n" + ."\n" + .'取值范围：3600秒~43200秒。默认值：3600秒。'."\n" + ."\n" + .'取值为空时将采用默认值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'NewDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'RAM角色描述。'."\n" + ."\n" + .'长度为1~1024个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS管理员', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Role' => [ + 'description' => 'RAM角色信息。', + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => 'RAM角色的资源描述符。', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => 'RAM角色的信任策略。', + 'type' => 'string', + 'example' => '{ \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::12345678901234****:root\\" } } ], \\"Version\\": \\"1\\" }', + ], + 'CreateDate' => [ + 'description' => 'RAM角色创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => 'RAM角色描述。', + 'type' => 'string', + 'example' => 'ECS管理角色', + ], + 'MaxSessionDuration' => [ + 'description' => 'RAM角色最大会话时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => 'RAM角色ID。', + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => 'RAM角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => '被授权RAM角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin@role.123456.onaliyunservice.com', + ], + 'UpdateDate' => [ + 'description' => 'RAM角色更新时间。', + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"ECSAdmin@role.123456.onaliyunservice.com\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\t90123456789****\\r\\n\\t\\tECSAdmin\\r\\n\\t\\tECSAdmin@role.123456.onaliyunservice.com\\r\\n\\t\\tacs:ram::123456789012****:role/ECSAdmin\\r\\n\\t\\tECS管理角色\\r\\n 3600\\r\\n\\t\\t{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t2016-01-23T12:33:18Z\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '更新角色信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetRole' => [ + 'summary' => '调用GetRole获取角色信息。', + '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' => '角色名称。'."\n" + ."\n" + .'长度为1~64个字符，可包含英文字母、数字、点号（.）和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECSAdmin', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。角色描述将以此语言返回。'."\n" + ."\n" + .'- en：英文。'."\n" + .'- zh-CN：中文。'."\n" + .'- ja：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Role' => [ + 'description' => '角色信息。', + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => '角色的资源描述符。', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => '扮演角色的权限策略内容。', + 'type' => 'string', + 'example' => '{ \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::12345678901234****:root\\" } } ], \\"Version\\": \\"1\\" }', + ], + 'CreateDate' => [ + 'description' => '角色创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => '角色描述。', + 'type' => 'string', + 'example' => 'ECS管理角色', + ], + 'IsServiceLinkedRole' => [ + 'description' => '是否为服务关联角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LatestDeletionTask' => [ + 'description' => '最近一次删除任务信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '删除任务创建时间。', + 'type' => 'string', + 'example' => '2018-10-23T12:33:18Z', + ], + 'DeletionTaskId' => [ + 'description' => '删除任务ID。', + 'type' => 'string', + 'example' => 'ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d', + ], + ], + ], + 'MaxSessionDuration' => [ + 'description' => '角色最大会话时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => '角色ID。', + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => '被授权角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin@role.123456.onaliyunservice.com', + ], + 'UpdateDate' => [ + 'description' => '角色更新时间。', + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"ECSAdmin@role.123456.onaliyunservice.com\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\t90123456789****\\r\\n\\t\\tECSAdmin\\r\\n\\t\\tECSAdmin@role.123456.onaliyunservice.com\\r\\n\\t\\tacs:ram::123456789012****:role/ECSAdmin\\r\\n\\t\\ttrue\\r\\n\\t\\t\\r\\n\\t\\t\\t2018-10-23T12:33:18Z\\r\\n\\t\\t\\tECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d\\r\\n\\t\\t\\r\\n\\t\\tECS管理角色\\r\\n 3600\\r\\n\\t\\t{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t2016-01-23T12:33:18Z\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取角色信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRoles' => [ + 'summary' => '调用ListRoles查看角色列表。', + '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' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。角色描述将以此语言返回。'."\n" + ."\n" + .'- en：英文。'."\n" + .'- zh-CN：中文。'."\n" + .'- ja：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => '角色信息。', + 'type' => 'array', + 'items' => [ + 'description' => '角色信息。', + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => '角色的资源描述符。', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/ECSAdmin', + ], + 'CreateDate' => [ + 'description' => '角色创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => '角色描述。', + 'type' => 'string', + 'example' => 'ECS管理角色', + ], + 'IsServiceLinkedRole' => [ + 'description' => '是否服务关联角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LatestDeletionTask' => [ + 'description' => '最近一次删除任务信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '删除任务创建时间。', + 'type' => 'string', + 'example' => '2018-10-23T12:33:18Z', + ], + 'DeletionTaskId' => [ + 'description' => '删除任务ID。', + 'type' => 'string', + 'example' => 'ECSAdmin/cc61514b-26eb-4453-ab53-b142eb70****', + ], + ], + ], + 'MaxSessionDuration' => [ + 'description' => '角色最大会话时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'RoleId' => [ + 'description' => '角色ID。', + 'type' => 'string', + 'example' => '90123456789****', + ], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin', + ], + 'RolePrincipalName' => [ + 'description' => '被授权角色名称。', + 'type' => 'string', + 'example' => 'ECSAdmin@role.123456.onaliyunservice.com', + ], + 'UpdateDate' => [ + 'description' => '角色更新时间。', + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '角色总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + '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\\": \\"ECSAdmin@role.123456.onaliyunservice.com\\",\\n \\"UpdateDate\\": \\"2016-01-23T12:33:18Z\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\r\\n\\t1\\r\\n\\t10\\r\\n\\t2\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t90123456789****\\r\\n\\t\\t\\tECSAdmin\\r\\n\\t\\t\\tECSAdmin@role.123456.onaliyunservice.com\\r\\n\\t\\t\\tacs:ram::123456789012****:role/ECSAdmin\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t2018-10-23T12:33:18Z\\r\\n\\t\\t\\t\\tECSAdmin/cc61514b-26eb-4453-ab53-b142eb70****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tECS管理角色\\r\\n 3600\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t90123456789****\\r\\n\\t\\t\\tOSSReadonlyAccess\\r\\n\\t\\t\\tOSSReadonlyAccess@role.123456.onaliyunservice.com\\r\\n\\t\\t\\tacs:ram::123456789012****:role/OSSReadonlyAccess\\r\\n\\t\\t\\tOSS只读访问角色\\r\\n 3600\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查看角色列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateServiceLinkedRole' => [ + 'summary' => '调用CreateServiceLinkedRole创建服务关联角色。', + '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' => '服务名称。'."\n" + ."\n" + .'具体信息，请参见[支持服务关联角色的云服务](~~461722~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'polardb.aliyuncs.com', + ], + ], + [ + 'name' => 'CustomSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '角色名称后缀。'."\n" + ."\n" + .'角色名称（含后缀）的总长度为1~64个字符，可包含英文字母、数字、半角句号（.）和短划线（-）。'."\n" + ."\n" + .'例如：假设后缀为`Example`，则角色名称为`ServiceLinkedRoleName_Example`，且最大长度不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'Example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '服务关联角色描述。'."\n" + ."\n" + .'只有允许自定义后缀的服务关联角色才能填写角色描述，否则，角色描述将使用预设值且不能修改。'."\n" + ."\n" + .'长度为1~1024个字符。', + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FE58D7CF-03BC-432A-B42D-BC3390C8C2E1', + ], + 'Role' => [ + 'description' => '角色信息。', + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => '角色的资源描述符。', + 'type' => 'string', + 'example' => 'acs:ram::177242285274****:role/aliyunserviceroleforpolardb', + ], + 'AssumeRolePolicyDocument' => [ + 'description' => '角色的信任策略内容。', + 'type' => 'string', + 'example' => '{\\"Statement\\":[{\\"Action\\":\\"sts:AssumeRole\\",\\"Effect\\":\\"Allow\\",\\"Principal\\":{\\"Service\\":[\\"polardb.aliyuncs.com\\"]}}],\\"Version\\":\\"1\\"}', + ], + 'CreateDate' => [ + 'description' => '角色创建时间（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-30T08:14:16Z', + ], + 'Description' => [ + 'description' => '角色描述。', + 'type' => 'string', + 'example' => 'Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.', + ], + 'IsServiceLinkedRole' => [ + 'description' => '是否为服务关联角色。取值：'."\n" + ."\n" + .'- true：是服务关联角色。'."\n" + .'- false：不是服务关联角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RoleId' => [ + 'description' => '角色ID。', + 'type' => 'string', + 'example' => '32833240981067****', + ], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'AliyunServiceRoleForPolarDB', + ], + 'RolePrincipalName' => [ + 'description' => '带域名后缀的角色名称。', + 'type' => 'string', + 'example' => 'AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n AliyunServiceRoleForPolarDB\\n Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.\\n {\\"Statement\\":[{\\"Action\\":\\"sts:AssumeRole\\",\\"Effect\\":\\"Allow\\",\\"Principal\\":{\\"Service\\":[\\"polardb.aliyuncs.com\\"]}}],\\"Version\\":\\"1\\"}\\n acs:ram::177242285274****:role/aliyunserviceroleforpolardb\\n true\\n 2020-06-30T08:14:16Z\\n 32833240981067****\\n AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com\\n \\n FE58D7CF-03BC-432A-B42D-BC3390C8C2E1\\n","errorExample":""}]', + 'title' => '创建服务关联角色', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteServiceLinkedRole' => [ + 'summary' => '调用DeleteServiceLinkedRole删除服务关联角色。', + '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' => '角色名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunServiceRoleForPolarDB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeletionTaskId' => [ + 'description' => '删除任务ID。', + 'type' => 'string', + 'example' => 'task/acs-service-role/polardb.aliyuncs.com/AliyunServiceRoleForPolarDB/64c4f9cc-fac2-4692-ae1b-804ae4b9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B595E5BF-FF5F-4E7F-B95A-B90FE242FEB6', + ], + ], + ], + ], + ], + '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":"\\n B595E5BF-FF5F-4E7F-B95A-B90FE242FEB6\\n task/acs-service-role/polardb.aliyuncs.com/AliyunServiceRoleForPolarDB/64c4f9cc-fac2-4692-ae1b-804ae4b9****\\n","errorExample":""}]', + 'title' => '删除服务关联角色', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetServiceLinkedRoleDeletionStatus' => [ + 'summary' => '调用GetServiceLinkedRoleDeletionStatus获取删除服务关联角色的任务状态。', + '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' => '删除任务ID。', + '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' => '删除任务失败的原因。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '失败信息。', + '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' => '使用服务关联角色的资源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '使用服务关联角色的资源信息。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'global', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表。', + 'type' => 'string', + 'example' => 'acs:hdr::196813227629****:sitepair/s-000h0y6kld0zwk8l****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '07194EB1-DB50-4513-A51D-99B30D635AEF', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- SUCCEEDED：删除成功。'."\n" + .'- IN_PROGRESS：正在删除中。'."\n" + .'- FAILED：删除失败。'."\n" + .'- NOT_STARTED：删除未开始。'."\n" + .'- INTERNAL_ERROR：内部异常错误。', + 'type' => 'string', + 'example' => 'FAILED', + ], + ], + ], + ], + ], + '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":"\\n\\n FAILED\\n 07194EB1-DB50-4513-A51D-99B30D635AEF\\n \\n Service-Linked Role acs:ram::196813227629****:role/aliyunserviceroleforhdr cannot be deleted as it is in use by hdr.aliyuncs.com.\\n \\n \\n global\\n \\n acs:hdr::196813227629****:sitepair/s-000h0y6kld0zwk8l****\\n \\n \\n \\n \\n","errorExample":""}]', + 'title' => '获取删除服务关联角色的任务状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePolicy' => [ + 'summary' => '调用CreatePolicy创建一个权限策略。', + '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' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略描述。'."\n" + ."\n" + .'长度为1~1024个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS管理员权限', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略内容。'."\n" + ."\n" + .'长度为1~6144个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => '权限策略信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '权限策略创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DefaultVersion' => [ + 'description' => '权限策略版本号。默认值：v1。'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Description' => [ + 'description' => '权限策略描述。', + 'type' => 'string', + 'example' => 'OSS管理员权限', + ], + 'PolicyName' => [ + 'description' => '权限策略名称。', + 'type' => 'string', + 'example' => 'OSS-Administrator', + ], + 'PolicyType' => [ + 'description' => '权限策略类型。取值：'."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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.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":"\\r\\n\\r\\n\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n\\t\\r\\n\\t\\tOSS-Administrator\\r\\n\\t\\tCustom\\r\\n\\t\\tOSS管理员权限\\r\\n\\t\\tv1\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建权限策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePolicy' => [ + 'summary' => '调用DeletePolicy删除指定的权限策略。', + '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' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '898FAB24-7509-43EE-A287-086FE4C44394', + ], + ], + ], + ], + ], + '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":"\\r\\n\\r\\n\\t898FAB24-7509-43EE-A287-086FE4C44394\\r\\n","errorExample":""}]', + 'title' => '删除权限策略', + 'description' => '> - 删除权限策略前，必须删除此权限策略的非默认版本。关于如何删除权限策略版本，请参见[DeletePolicyVersion](~~159041~~)。'."\n" + .'> - 删除权限策略前，应保证当前权限策略未被引用（即未授予RAM用户、用户组或RAM角色）。关于如何移除授权，请参见[DetachPolicy](~~159168~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetDefaultPolicyVersion' => [ + 'summary' => '调用SetDefaultPolicyVersion设置权限策略默认版本。', + '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' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略版本标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'v2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '设置权限策略默认版本', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachPolicy' => [ + 'summary' => '调用AttachPolicy为授权对象（RAM用户、RAM用户组或RAM角色）添加权限策略，即授权。完成授权后，被授权对象将获得指定资源组或阿里云账号内资源的访问权限。', + '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' => '授权范围。取值：'."\n" + ."\n" + .'- 资源组ID：权限在指定的资源组内生效。'."\n" + .'- 阿里云账号ID：被授权对象所属的阿里云账号ID，权限在该阿里云账号内生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略类型。取值：'."\n" + ."\n" + .'- Custom：自定义权限策略。'."\n" + .'- System：系统权限策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'System', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'AdministratorAccess', + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'description' => '被授权对象类型。取值：'."\n" + ."\n" + .'- IMSUser：RAM用户。'."\n" + .'- IMSGroup：RAM用户组。'."\n" + .'- ServiceRole：RAM角色。', + 'type' => 'string', + 'required' => true, + 'example' => 'IMSUser', + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'description' => '被授权对象的名称。具体如下：'."\n" + ."\n" + .'- RAM用户：格式为@.onaliyun.com，其中为RAM用户名称，为账号别名。'."\n" + .'- RAM用户组：格式为@group..onaliyun.com，其中为RAM用户组名称，为账号别名。'."\n" + .'- RAM角色：格式为@role..onaliyunservice.com，其中为RAM角色名称，为账号别名。'."\n" + ."\n" + .'> 账号别名是默认域名中的一部分，请调用[GetDefaultDomain](~~186720~~)获取账号别名。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'alice@demo.onaliyun.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t697852FB-50D7-44D9-9774-530C31EAC572\\r\\n","errorExample":""}]', + 'title' => '为RAM身份授权', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachPolicy' => [ + 'summary' => '调用DetachPolicy移除指定对象的权限策略。移除授权后，该对象将失去对当前资源组或账号中资源的操作权限。', + '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' => '资源组ID或资源组所属的云账号ID。'."\n" + ."\n" + .'指定要从哪个资源组或云账号中移除授权。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略类型。取值：'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'description' => '被授权对象类型。取值：'."\n" + ."\n" + .'- IMSUser：RAM用户。'."\n" + .'- IMSGroup：RAM用户组。'."\n" + .'- ServiceRole：RAM角色。', + 'type' => 'string', + 'required' => true, + 'example' => 'IMSUser', + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'description' => '被授权对象名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice@demo.onaliyun.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t697852FB-50D7-44D9-9774-530C31EAC572\\r\\n","errorExample":""}]', + 'title' => '为RAM身份移除权限', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPolicies' => [ + 'summary' => '调用ListPolicies查看权限策略列表。', + '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' => '权限策略类型。取值为空表示列出所有类型的权限策略。 '."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。系统权限策略的描述将以此语言返回。'."\n" + ."\n" + .'- en：英文。'."\n" + .'- zh-CN：中文。'."\n" + .'- ja：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Policies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Policy' => [ + 'description' => '权限策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '权限策略信息。', + 'type' => 'object', + 'properties' => [ + 'AttachmentCount' => [ + 'description' => '引用次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateDate' => [ + 'description' => '权限策略创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DefaultVersion' => [ + 'description' => '权限策略默认版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'Description' => [ + 'description' => '权限策略描述。', + 'type' => 'string', + 'example' => 'OSS管理员权限', + ], + 'PolicyName' => [ + 'description' => '权限策略名称。', + 'type' => 'string', + 'example' => 'OSS-Administrator', + ], + 'PolicyType' => [ + 'description' => '权限策略类型。'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'UpdateDate' => [ + 'description' => '权限策略更新时间。', + 'type' => 'string', + 'example' => '2016-02-11T18:39:12Z', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + '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":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n 1\\n 10\\n 2\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n 1\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-11T18:39:12Z\\n 2015-02-11T18:39:12Z\\n 2\\n \\n \\n","errorExample":""}]', + 'title' => '查看权限策略列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPolicy' => [ + 'summary' => '调用GetPolicy获取指定的权限策略信息。', + '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' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略类型。取值：'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + 'enum' => [ + 'Custom', + 'System', + ], + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。系统权限策略的描述将以此语言返回。取值：'."\n" + ."\n" + .'- en：英文。'."\n" + .'- zh-CN：中文。'."\n" + .'- ja：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => '权限策略信息。', + 'type' => 'object', + 'properties' => [ + 'AttachmentCount' => [ + 'description' => '引用次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateDate' => [ + 'description' => '权限策略创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'DefaultVersion' => [ + 'description' => '权限策略默认版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'Description' => [ + 'description' => '权限策略描述。', + 'type' => 'string', + 'example' => 'OSS管理员权限', + ], + 'PolicyDocument' => [ + 'description' => '权限策略内容。', + 'type' => 'string', + 'example' => ' { "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}', + ], + 'PolicyName' => [ + 'description' => '权限策略名称。', + 'type' => 'string', + 'example' => 'OSS-Administrator', + ], + 'PolicyType' => [ + 'description' => '权限策略类型。取值：'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'UpdateDate' => [ + 'description' => '权限策略更新时间。', + 'type' => 'string', + 'example' => '2016-01-23T12:33:18Z', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t697852FB-50D7-44D9-9774-530C31EAC572\\r\\n\\t\\r\\n\\t\\tOSS-Administrator\\r\\n\\t\\tCustom\\r\\n\\t\\tOSS管理员权限\\r\\n\\t\\tv1\\r\\n\\t\\t{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t2016-01-23T12:33:18Z\\r\\n\\t\\t0\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取指定的权限策略信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPolicyAttachments' => [ + 'summary' => '调用ListPolicyAttachments查看授权列表。', + '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' => '资源组ID或资源组所属的阿里云账号ID。取值为空表示列出当前账号下的所有授权记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-001', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略类型。取值为空表示列出所有类型的权限策略。'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'System', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'AdministratorAccess', + ], + ], + [ + 'name' => 'PrincipalType', + 'in' => 'query', + 'schema' => [ + 'description' => '被授权对象类型。取值为空表示列出所有类型的被授权对象。'."\n" + ."\n" + .'- IMSUser：RAM用户。'."\n" + .'- IMSGroup：RAM用户组。'."\n" + .'- ServiceRole：RAM角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'IMSUser', + ], + ], + [ + 'name' => 'PrincipalName', + 'in' => 'query', + 'schema' => [ + 'description' => '被授权对象名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'alice@demo.onaliyun.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。系统权限策略的描述将以此语言返回。'."\n" + ."\n" + .'- en：英文。'."\n" + .'- zh-CN：中文。'."\n" + .'- ja：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PolicyAttachments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolicyAttachment' => [ + 'description' => '权限策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '权限策略信息。', + 'type' => 'object', + 'properties' => [ + 'AttachDate' => [ + 'description' => '授权时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'Description' => [ + 'description' => '权限策略描述。', + 'type' => 'string', + 'example' => '管理员权限', + ], + 'PolicyName' => [ + 'description' => '权限策略名称。', + 'type' => 'string', + 'example' => 'AdministratorAccess', + ], + 'PolicyType' => [ + 'description' => '权限策略类型。'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'example' => 'System', + ], + 'PrincipalName' => [ + 'description' => '被授权对象名称。', + 'type' => 'string', + 'example' => 'alice@demo.onaliyun.com', + ], + 'PrincipalType' => [ + 'description' => '被授权对象类型。'."\n" + ."\n" + .'- IMSUser：RAM用户。'."\n" + .'- IMSGroup：RAM用户组。'."\n" + .'- ServiceRole：RAM角色。', + 'type' => 'string', + 'example' => 'IMSUser', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID或资源组所属的阿里云账号ID。', + 'type' => 'string', + 'example' => 'rg-9gLOoK****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + '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\\": \\"alice@demo.onaliyun.com\\",\\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":"\\r\\n\\r\\n\\t7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\r\\n\\t1\\r\\n\\t10\\r\\n\\t2\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\trg-9gLOoK****\\r\\n\\t\\t\\tSystem\\r\\n\\t\\t\\tAdministratorAccess\\r\\n\\t\\t\\tIMSUser\\r\\n\\t\\t\\talice@demo.onaliyun.com\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\t管理员权限\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t12983255839348****\\r\\n\\t\\t\\tCustom\\r\\n\\t\\t\\tOSS-Bucket1-Access\\r\\n\\t\\t\\tServiceRole\\r\\n\\t\\t\\timage-service@role.demo.onaliyunservice.com\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\tOSS bucket 1的访问权限\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查看授权列表', + 'description' => '您可以查看以下信息：'."\n" + ."\n" + .'- 阿里云账号或资源组下的所有授权记录。'."\n" + .'- RAM用户、RAM用户组、RAM角色被授予的所有权限策略。'."\n" + .'- 阿里云账号或资源组下拥有某个权限的RAM用户、RAM用户组、RAM角色。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePolicyVersion' => [ + 'summary' => '调用CreatePolicyVersion创建权限策略版本。', + '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' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略内容。'."\n" + ."\n" + .'长度为1~6144个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}', + ], + ], + [ + 'name' => 'SetAsDefault', + 'in' => 'query', + 'schema' => [ + 'description' => '是否设置为默认权限策略。 '."\n" + ."\n" + .'- false（默认值）：不设置为默认权限策略。'."\n" + .'- true：设置为默认权限策略。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersion' => [ + 'description' => '权限策略版本信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '权限策略版本创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18', + ], + 'IsDefaultVersion' => [ + 'description' => '是否为权限策略默认版本。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VersionId' => [ + 'description' => '权限策略版本标识。', + 'type' => 'string', + 'example' => 'v3', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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.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":"\\r\\n\\r\\n\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n\\t\\r\\n\\t\\tv3\\r\\n\\t\\tfalse\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建权限策略版本', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePolicyVersion' => [ + 'summary' => '调用DeletePolicyVersion删除权限策略版本。', + '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' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略版本标识。'."\n" + ."\n" + .'您可以调用[ListPolicyVersions](~~159982~~)查询权限策略版本标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'v3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n\\t\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '删除权限策略版本', + 'description' => '> 权限策略默认版本不能删除。', + 'requestParamsDescription' => ' 关于公共请求参数的详情，请参见[公共参数](~~159973~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPolicyVersions' => [ + 'summary' => '调用ListPolicyVersions查看权限策略版本列表。', + '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' => '权限策略类型。取值：'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolicyVersion' => [ + 'description' => '权限策略版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '权限策略版本信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '权限策略版本创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'IsDefaultVersion' => [ + 'description' => '是否为权限策略默认版本。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VersionId' => [ + 'description' => '权限策略版本标识。', + 'type' => 'string', + 'example' => 'v3', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB', + ], + ], + ], + ], + ], + '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":"\\r\\n\\r\\n\\t7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tv3\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tv5\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t2015-02-26T01:25:52Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查看权限策略版本列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPolicyVersion' => [ + 'summary' => '调用GetPolicyVersion获取某个权限策略的版本。', + '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' => '权限策略类型。取值：'."\n" + ."\n" + .'- Custom：自定义策略。'."\n" + .'- System：系统策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + 'enum' => [ + 'Custom', + 'System', + ], + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略名称。'."\n" + ."\n" + .'长度为1~128个字符，可包含英文字母、数字和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS-Administrator', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '权限策略版本标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'v3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyVersion' => [ + 'description' => '权限策略版本信息。', + 'type' => 'object', + 'properties' => [ + 'CreateDate' => [ + 'description' => '权限策略版本创建时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'IsDefaultVersion' => [ + 'description' => '是否为权限策略默认版本。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PolicyDocument' => [ + 'description' => '权限策略内容。', + 'type' => 'string', + 'example' => '{ \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}', + ], + 'VersionId' => [ + 'description' => '权限策略版本标识。', + 'type' => 'string', + 'example' => 'v3', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE', + ], + ], + ], + ], + ], + '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":"\\r\\n\\r\\n\\t9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n\\t\\r\\n\\t\\tv3\\r\\n\\t\\tfalse\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取某个权限策略的版本', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '调用TagResources为资源组或资源目录的成员绑定标签。', + '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' => '资源组ID或资源目录成员ID。'."\n" + ."\n" + .'最多可以指定50个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID或资源目录成员ID。'."\n" + ."\n" + .'最多可以指定50个。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz6bre2uq****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签。'."\n" + ."\n" + .'最多可以绑定20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。'."\n" + ."\n" + .'最多可以绑定20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'最多支持128个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- ResourceGroup（默认值）：为资源组绑定标签。'."\n" + .'- Account：为资源目录成员绑定标签。'."\n" + ."\n" + .'> 当为资源目录成员绑定标签时，该参数为必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\n","errorExample":""}]', + 'title' => '绑定标签', + ], + 'UntagResources' => [ + 'summary' => '调用UntagResources解绑资源组或资源目成员的标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑指定资源组或资源目录成员的全部标签。取值：'."\n" + .'- false（默认值）：否'."\n" + .'- true：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源组ID或资源目录成员ID。'."\n" + ."\n" + .'最多可以指定50个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID或资源目录成员ID。'."\n" + ."\n" + .'最多可以指定50个。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2dpwyrfr****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签键。'."\n" + ."\n" + .'最多可以解绑20个标签键。'."\n" + ."\n" + .'> 当解绑全部标签的参数`All`取值为`true`时，不需要设置标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。'."\n" + ."\n" + .'最多可以解绑20个标签键。'."\n" + .'> 当解绑全部标签的参数`All`取值为`true`时，不需要设置标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- ResourceGroup（默认值）：解绑资源组的标签。'."\n" + .'- Account：解绑资源目录成员的标签。'."\n" + ."\n" + .'> 当解绑资源目录成员的标签时，该参数为必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\n","errorExample":""}]', + 'title' => '解绑标签', + ], + 'ListTagResources' => [ + 'summary' => '调用ListTagResources查询资源组或资源目录成员绑定的标签列表。', + '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' => '下一个查询开始的Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '标签。查询的过滤条件。'."\n" + ."\n" + .'最多可以指定20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。查询的过滤条件。'."\n" + ."\n" + .'最多可以指定20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源组ID或资源目录成员ID。查询的过滤条件。'."\n" + ."\n" + .'> 查询资源目录成员绑定的标签列表时，必须同时指定`ResourceId`和`ResourceType`，且`ResourceType`取值为`Account`。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID或资源目录成员ID。查询的过滤条件。'."\n" + ."\n" + .'> 查询资源目录成员绑定的标签列表时，必须同时指定`ResourceId`和`ResourceType`，且`ResourceType`取值为`Account`。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz6bre2uq****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。查询的过滤条件。取值：'."\n" + ."\n" + .'- ResourceGroup（默认值）：查询资源组的标签。'."\n" + .'- Account：查询资源目录成员的标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '根据`NextToken`判断是否具备下一个查询开始的`Token`。取值：'."\n" + ."\n" + .'- 如果`NextToken`为空，即`"NextToken": ""`，表示没有下一个。'."\n" + .'- 如果`NextToken`有值，则该值就是下一个查询开始的`Token`。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8054B059-6B36-53BF-AA45-B8C9A0ED05AB', + ], + 'TagResources' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源组ID或资源目录成员ID。', + 'type' => 'string', + 'example' => 'rg-aekz6bre2uq****', + ], + 'ResourceType' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- resourcegroup：资源组。'."\n" + .'- Account：资源目录成员。', + 'type' => 'string', + 'example' => 'resourcegroup', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => '标签值。', + '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":"\\n 8054B059-6B36-53BF-AA45-B8C9A0ED05AB\\n \\n rg-aekz6bre2uq****\\n k1\\n resourcegroup\\n v1\\n \\n","errorExample":""}]', + 'title' => '查询标签列表', + ], + 'ListTagKeys' => [ + 'summary' => '调用ListTagKeys查询资源目录成员的标签键列表。', + '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' => '下一个查询开始的Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '单次请求返回结果的最大条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'取值：Account，表示资源目录的成员。', + 'type' => 'string', + 'required' => true, + 'example' => 'Account', + ], + ], + [ + 'name' => 'KeyFilter', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊查询的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'team', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '根据NextToken判断是否具备下一个查询开始的Token。取值：'."\n" + ."\n" + .'- 如果NextToken为空，即`"NextToken": ""`，表示没有下一个。'."\n" + .'- 如果NextToken有值，则该值就是下一个查询开始的Token。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DC09A6AA-2713-4E10-A2E9-E6C5C43A8842', + ], + 'Tags' => [ + 'description' => '标签键信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + '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":"\\n caeba0bbb2be03f84eb48b699f0a****\\n DC09A6AA-2713-4E10-A2E9-E6C5C43A8842\\n \\n team\\n \\n","errorExample":""}]', + 'title' => '查询标签键列表', + ], + 'ListTagValues' => [ + 'summary' => '调用ListTagValues查询指定标签键对应的标签值。', + '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' => '下一个查询开始的Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '单次请求返回结果的最大条数。'."\n" + ."\n" + .'取值范围：1~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'取值：Account，表示资源目录的成员。', + 'type' => 'string', + 'required' => true, + 'example' => 'Account', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键，用于查询的过滤条件。', + 'type' => 'string', + 'required' => true, + 'example' => 'k1', + ], + ], + [ + 'name' => 'ValueFilter', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊查询的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '根据NextToken判断是否具备下一个查询开始的Token。取值：'."\n" + ."\n" + .'- 如果NextToken为空，即`"NextToken": ""`，表示没有下一个。'."\n" + .'- 如果NextToken有值，则该值就是下一个查询开始的Token。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DC09A6AA-2713-4E10-A2E9-E6C5C43A8842', + ], + 'Tags' => [ + 'description' => '标签值信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值信息。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签值。', + '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":"\\n TGlzdFJlc291cm****\\n DC09A6AA-2713-4E10-A2E9-E6C5C43A8842\\n \\n v1\\n \\n","errorExample":""}]', + 'title' => '查询指定标签键对应的标签值', + 'description' => '### 使用说明'."\n" + .'本文将提供一个示例，查询标签键k1对应的标签值。返回结果显示：标签键k1对应的标签值为v1。', + ], + 'InitResourceDirectory' => [ + 'summary' => '调用InitResourceDirectory开通资源目录。开通资源目录后，系统会为您创建一个Root资源夹，并将当前账号设置为企业管理账号。该企业管理账号具有管理资源目录的所有权限。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => 'CD76D376-2517-4924-92C5-DBC52262F93A', + ], + 'ResourceDirectory' => [ + 'description' => '资源目录信息。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '资源目录开通时间。', + 'type' => 'string', + 'example' => '2019-02-18T15:32:10.473Z', + ], + 'MasterAccountId' => [ + 'description' => '企业管理账号ID。', + 'type' => 'string', + 'example' => '172841235500****', + ], + 'MasterAccountName' => [ + 'description' => '企业管理账号名称。', + 'type' => 'string', + 'example' => 'aliyun-****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-Ss****', + ], + 'RootFolderId' => [ + 'description' => 'Root资源夹ID。', + '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":"\\r\\n\\r\\n \\r\\n r-Zo****\\r\\n rd-Ss****\\r\\n 172841235500****\\r\\n aliyun-****\\r\\n 2019-02-18T15:32:10.473Z\\r\\n \\r\\n CD76D376-2517-4924-92C5-DBC52262F93A\\r\\n","errorExample":""}]', + 'title' => '开通资源目录', + 'description' => '> - 请使用经过企业实名认证的账号开通资源目录。个人实名认证账号不能开通资源目录。'."\n" + .'> - 建议您将企业管理账号仅作为资源目录的管理员，不建议您在企业管理账号下订购云产品资源。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCloudAccount' => [ + 'summary' => '创建资源目录云账号类型的成员。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '成员名称。'."\n" + ."\n" + .'长度为2~50个字符或汉字，可包含汉字、英文字母、数字、下划线（_）、英文句点（.）和短划线（-）。'."\n" + ."\n" + .'成员名称在资源目录内必须唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'admin-****', + ], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => [ + 'description' => '父资源夹ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fd-bVaRIG****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '云账号登录邮箱。', + 'type' => 'string', + 'required' => true, + 'example' => 'someone@example.com', + ], + ], + [ + 'name' => 'PayerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '结算账号ID。取值为空表示采用当前账号结算。', + 'type' => 'string', + 'required' => false, + 'example' => '12323344****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin-****', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => '账号记录ID。', + 'type' => 'string', + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => '成员加入状态。'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- CreateVerifying：创建确认中。'."\n" + .'- CreateFailed：创建失败。'."\n" + .'- CreateExpired：创建过期。'."\n" + .'- CreateCancelled：创建取消。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。'."\n" + .'- Removed：已移出。', + 'type' => 'string', + 'example' => 'CreateVerifying', + ], + 'Type' => [ + 'description' => '成员类型。取值为CloudAccount表示云账号。', + 'type' => 'string', + 'example' => 'CloudAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"someone@example.com\\",\\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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n \\r\\n rd-k3****\\r\\n 12323344****\\r\\n someone@example.com\\r\\n admin-****\\r\\n fd-bVaRIG****\\r\\n created\\r\\n CloudAccount\\r\\n CreateVerifying\\r\\n 06950264-3f0d-4ca9-82dd-6ee7a3d3****\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n","errorExample":""}]', + 'title' => '创建云账号类型的成员', + 'description' => '资源目录中有资源账号和云账号两种不同类型的成员。 '."\n" + ."\n" + .'- 资源账号（推荐）：资源账号类型的成员只作为资源的容器并完全依赖于资源目录存在，是一种更为安全、创建更为简单的账号。创建资源账号类型的成员，请参见[CreateResourceAccount](~~159392~~)。 '."\n" + ."\n" + .'> 资源账号也可以升级为云账号，请参见[PromoteResourceAccount](~~159395~~)。'."\n" + ."\n" + .'- 云账号：云账号具备阿里云账号的全部特征，包括允许Root登录访问。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PromoteResourceAccount' => [ + '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' => [ + 'description' => '需要升级的资源账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12323344****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '升级后的云账号登录邮箱。', + 'type' => 'string', + 'required' => true, + 'example' => 'someone@example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'JoinTime' => [ + 'description' => '成员加入时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => '账号记录ID。', + 'type' => 'string', + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d33d6b', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => '成员加入状态。'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- CreateVerifying：创建确认中。'."\n" + .'- CreateFailed：创建失败。'."\n" + .'- CreateExpired：创建过期。'."\n" + .'- CreateCancelled：创建取消。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。'."\n" + .'- Removed：已移出。', + 'type' => 'string', + 'example' => 'PromoteVerifying', + ], + 'Type' => [ + 'description' => '成员类型。'."\n" + ."\n" + .'- CloudAccount：云账号。'."\n" + .'- ResourceAccount：资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"someone@example.com\\",\\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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n \\r\\n rd-k3****\\r\\n 12323344****\\r\\n admin\\r\\n fd-bVaRIG****\\r\\n created\\r\\n 2015-01-23T12:33:18Z\\r\\n ResourceAccount\\r\\n PromoteVerifying\\r\\n 06950264-3f0d-4ca9-82dd-6ee7a3d33d6b\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n","errorExample":""}]', + 'title' => '将资源账号升级为云账号', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResendPromoteResourceAccountEmail' => [ + 'summary' => '重新发送资源账号升级为云账号的确认邮件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '账号记录ID。', + 'type' => 'string', + 'required' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'JoinTime' => [ + 'description' => '成员加入时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => '账号记录ID。', + 'type' => 'string', + 'example' => '16950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => '成员加入状态。'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- CreateVerifying：创建确认中。'."\n" + .'- CreateFailed：创建失败。'."\n" + .'- CreateExpired：创建过期。'."\n" + .'- CreateCancelled：创建取消。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。'."\n" + .'- Removed：已移出。', + 'type' => 'string', + 'example' => 'PromoteVerifying', + ], + 'Type' => [ + 'description' => '成员类型。'."\n" + ."\n" + .'- CloudAccount：云账号。'."\n" + .'- ResourceAccount：资源账号。', + 'type' => 'string', + 'example' => 'ResourceAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"someone@example.com\\",\\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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n \\r\\n rd-k3****\\r\\n 12323344****\\r\\n admin\\r\\n fd-bVaRIG****\\r\\n created\\r\\n 2015-01-23T12:33:18Z\\r\\n ResourceAccount\\r\\n PromoteVerifying\\r\\n 16950264-3f0d-4ca9-82dd-6ee7a3d33d6b\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n","errorExample":""}]', + 'title' => '重新发送资源账号升级云账号邮件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResendCreateCloudAccountEmail' => [ + 'summary' => '重新发送创建云账号的确认邮件。', + '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' => '账号记录ID。', + 'type' => 'string', + 'required' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '12323344****', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'someone@example.com', + ], + 'DisplayName' => [ + 'description' => '成员名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FolderId' => [ + 'description' => '资源夹ID。', + 'type' => 'string', + 'example' => 'fd-bVaRIG****', + ], + 'JoinMethod' => [ + 'description' => '成员加入方式。'."\n" + ."\n" + .'- invited：邀请。'."\n" + .'- created：创建。', + 'type' => 'string', + 'example' => 'created', + ], + 'JoinTime' => [ + 'description' => '成员加入时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'ModifyTime' => [ + 'description' => '成员修改时间。', + 'type' => 'string', + 'example' => '2015-01-23T12:33:18Z', + ], + 'RecordId' => [ + 'description' => '账号记录ID。', + 'type' => 'string', + 'example' => '16950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + 'ResourceDirectoryId' => [ + 'description' => '资源目录ID。', + 'type' => 'string', + 'example' => 'rd-k3****', + ], + 'Status' => [ + 'description' => '成员加入状态。'."\n" + ."\n" + .'- CreateSuccess：创建成功。'."\n" + .'- CreateVerifying：创建确认中。'."\n" + .'- CreateFailed：创建失败。'."\n" + .'- CreateExpired：创建过期。'."\n" + .'- CreateCancelled：创建取消。'."\n" + .'- PromoteVerifying：升级确认中。'."\n" + .'- PromoteFailed：升级失败。'."\n" + .'- PromoteExpired：升级过期。'."\n" + .'- PromoteCancelled：升级取消。'."\n" + .'- PromoteSuccess：升级成功。'."\n" + .'- InviteSuccess：邀请成功。'."\n" + .'- Removed：已移出。', + 'type' => 'string', + 'example' => 'CreateVerifying', + ], + 'Type' => [ + 'description' => '成员类型。取值为CloudAccount表示云账号。', + 'type' => 'string', + 'example' => 'CloudAccount', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": \\"someone@example.com\\",\\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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n \\r\\n rd-k3****\\r\\n 12323344****\\r\\n admin\\r\\n fd-bVaRIG****\\r\\n created\\r\\n 2015-01-23T12:33:18Z\\r\\n CloudAccount\\r\\n CreateVerifying\\r\\n 16950264-3f0d-4ca9-82dd-6ee7a3d33d6b\\r\\n 2015-01-23T12:33:18Z\\r\\n \\r\\n","errorExample":""}]', + 'title' => '重新发送创建云账号的邮件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelCreateCloudAccount' => [ + 'summary' => '取消创建资源目录云账号类型的成员。', + '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' => '账号记录ID。', + 'type' => 'string', + 'required' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '取消创建云账号类型的成员', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelPromoteResourceAccount' => [ + 'summary' => '取消升级资源目录资源账号为云账号。', + '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' => '账号记录ID。', + 'type' => 'string', + 'required' => true, + 'example' => '06950264-3f0d-4ca9-82dd-6ee7a3d3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"\\r\\n\\r\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\r\\n","errorExample":""}]', + 'title' => '取消升级资源账号为云账号', + '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', + ], + ], +]; -- cgit v1.2.3