diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/resourcesharing | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/resourcesharing')
| -rw-r--r-- | data/en_us/resourcesharing/2020-01-10/api-docs.php | 5430 |
1 files changed, 5430 insertions, 0 deletions
diff --git a/data/en_us/resourcesharing/2020-01-10/api-docs.php b/data/en_us/resourcesharing/2020-01-10/api-docs.php new file mode 100644 index 0000000..5af6589 --- /dev/null +++ b/data/en_us/resourcesharing/2020-01-10/api-docs.php @@ -0,0 +1,5430 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ResourceSharing', + 'version' => '2020-01-10', + ], + 'directories' => [ + [ + 'id' => 165993, + 'title' => 'Resource shares', + 'type' => 'directory', + 'children' => [ + 'EnableSharingWithResourceDirectory', + 'CreateResourceShare', + 'ListResourceShares', + 'UpdateResourceShare', + 'DeleteResourceShare', + 'AssociateResourceShare', + 'DisassociateResourceShare', + 'ListResourceShareAssociations', + 'ListSharedResources', + 'ListSharedTargets', + 'DescribeRegions', + 'CheckSharingWithResourceDirectoryStatus', + 'ChangeResourceGroup', + 'TagResources', + 'ListTagResources', + 'UntagResources', + ], + ], + [ + 'id' => 165991, + 'title' => 'Resource sharing invitations', + 'type' => 'directory', + 'children' => [ + 'ListResourceShareInvitations', + 'AcceptResourceShareInvitation', + 'RejectResourceShareInvitation', + ], + ], + [ + 'id' => 166002, + 'title' => 'Resource sharing permissions', + 'type' => 'directory', + 'children' => [ + 'AssociateResourceSharePermission', + 'DisassociateResourceSharePermission', + 'ListResourceSharePermissions', + 'GetPermission', + 'ListPermissionVersions', + 'ListPermissions', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'EnableSharingWithResourceDirectory' => [ + 'summary' => 'Enables resource sharing for a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 409 => [ + [ + 'errorCode' => 'ActionNotPermitted', + 'errorMessage' => 'The caller must be the master account for the Resource Directory.', + ], + [ + 'errorCode' => 'AlreadyEnabled', + 'errorMessage' => 'You have already enabled sharing with the Resource Directory.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableSharingWithResourceDirectoryResponse>\\n <RequestId>2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA</RequestId>\\n</EnableSharingWithResourceDirectoryResponse>","errorExample":""}]', + 'title' => 'EnableSharingWithResourceDirectory', + 'description' => 'You can share your resources with all members in your resource directory, all members in a specific folder in your resource directory, or a specific member in your resource directory as a resource owner only after you enable resource sharing for your resource directory.'."\n" + ."\n" + .'You can call this API operation only by using the management account of your resource directory or a RAM user or RAM role to which the required permissions are granted within the management account.', + ], + 'CreateResourceShare' => [ + 'summary' => 'Creates a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource share.'."\n" + ."\n" + .'The name must be 1 to 50 characters in length.'."\n" + ."\n" + .'The name can contain letters, digits, periods (.), underscores (\\_), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the shared resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The shared resource.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The ID of a shared resource.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time.'."\n" + ."\n" + .'> `Resources.N.ResourceId` and `Resources.N.ResourceType` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp183p93qs667muql****', + ], + 'ResourceType' => [ + 'description' => 'The type of a shared resource.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n" + ."\n" + .'> `Resources.N.ResourceId` and `Resources.N.ResourceType` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitch', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the principals.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a principal.'."\n" + ."\n" + .'* If the value of `AllowExternalTargets` is `false`, you can set this parameter to the ID of a resource directory, folder, or member.'."\n" + .'* If the value of `AllowExternalTargets` is `true`, you can set this parameter to the ID of an Alibaba Cloud account, resource directory, folder, or member or the name of an Alibaba Cloud service.'."\n" + ."\n" + .'For more information, see [Resource sharing modes](~~160622~~), [View the ID of a resource directory](~~111217~~), [View the ID of a folder](~~111223~~), or [View the ID of a member](~~111624~~).'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five principals can be specified at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + 'required' => false, + 'example' => '172050525300****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceArns', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'PermissionNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the permissions. If you do not configure this parameter, the system automatically associates the default permission for the specified resource type with the resource share. For more information, see [Permission library](~~465474~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of a permission. If you do not configure this parameter, the system automatically associates the default permission for the specified resource type with the resource share. For more information, see [Permission library](~~465474~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AllowExternalTargets', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether resources in the resource share can be shared with accounts outside the resource directory. Valid values:'."\n" + ."\n" + .'* false (default): Resources in the resource share can be shared only with accounts in the resource directory.'."\n" + .'* true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz5nlvlak****', + ], + ], + [ + 'name' => 'TargetProperties', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The properties of the principal.'."\n" + ."\n" + .'> This parameter is available only when you specify an Alibaba Cloud service as a principal.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Property' => [ + 'description' => 'The property parameter of the principal. For example, you can specify a parameter that indicates the time range for resource sharing. Valid values of `timeRangeType`:'."\n" + ."\n" + .'* timeRange: a specific time range'."\n" + .'* day: all day'."\n" + ."\n" + .'> `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "timeRange":{'."\n" + .' "timeRangeType":"timeRange",'."\n" + .' "beginAtTime":"00:00",'."\n" + .' "timezone":"UTC+8",'."\n" + .' "endAtTime":"19:59"'."\n" + .' }'."\n" + .'}', + ], + 'TargetId' => [ + 'description' => 'The ID of the principal.'."\n" + ."\n" + .'> `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceProperties', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源属性列表。', + 'type' => 'array', + 'items' => [ + 'title' => '资源属性列表。', + 'type' => 'object', + 'properties' => [ + 'Property' => [ + 'title' => '资源属性。', + 'type' => 'string', + 'example' => '{"sharePrincipals":true,"shareTagOptions":false}', + ], + 'ResourceArn' => [ + 'title' => '资源ARN。', + 'type' => 'string', + 'example' => 'acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****', + ], + ], + ], + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags. You can specify up to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'> The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n" + ."\n" + .'> The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2C3FA051-61DC-4F3E-81E9-E4830524DF4B', + ], + 'ResourceShare' => [ + 'description' => 'The information about the resource share.'."\n", + 'type' => 'object', + 'properties' => [ + 'AllowExternalTargets' => [ + 'description' => 'Indicates whether resources in the resource share can be shared with accounts outside the resource directory. Valid values:'."\n" + ."\n" + .'* false: Resources in the resource share can be shared only with accounts in the resource directory.'."\n" + .'* true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource share was created.'."\n", + 'type' => 'string', + 'example' => '2020-12-03T08:02:22.413Z', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-qSkW1HBY****', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceShareOwner' => [ + 'description' => 'The owner of the resource share.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'ResourceShareStatus' => [ + 'description' => 'The status of the resource share. Valid values:'."\n" + ."\n" + .'* Active: The resource share is enabled.'."\n" + .'* Pending: The resource share is associated with one or more resource sharing invitations that are waiting for confirmation.'."\n" + .'* Deleting: The resource share is being deleted.'."\n" + .'* Deleted: The resource share is deleted.'."\n" + ."\n" + .'> The system automatically deletes the records of resource shares in the Deleted state within 48 hours to 96 hours after you delete the resource shares.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'UpdateTime' => [ + 'description' => 'The time when the resource share was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-03T08:02:22.413Z', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceShareName', + 'errorMessage' => 'The ResourceShareName is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareName.Length', + 'errorMessage' => 'The maximum length of ResourceShareName exceeds 50 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources', + 'errorMessage' => 'The Resources is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources.Duplicate', + 'errorMessage' => 'The Resources contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources.Length', + 'errorMessage' => 'The maximum number of Resources exceeds 5.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets', + 'errorMessage' => 'The Targets is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Duplicate', + 'errorMessage' => 'The Targets contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Length', + 'errorMessage' => 'The maximum number of Targets exceeds 5.', + ], + [ + 'errorCode' => 'InvalidTarget', + 'errorMessage' => 'The shared target does not exist in the resource directory.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceShareName', + 'errorMessage' => 'You must specify ResourceShareName.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.PermissionNames.Duplicate', + 'errorMessage' => 'The PermissionNames duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.PermissionNames.Length', + 'errorMessage' => 'The maximum length of PermissionNames exceeds quota limit.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetProperties', + 'errorMessage' => 'The TargetProperties is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetProperties.Duplicate', + 'errorMessage' => 'The TargetProperties contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetProperties.Length', + 'errorMessage' => 'The TargetProperties beyond the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns', + 'errorMessage' => 'The ResourceArns is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Duplicate', + 'errorMessage' => 'The ResourceArns contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Length', + 'errorMessage' => 'The ResourceArns beyond the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceConflict', + 'errorMessage' => 'Both Resources and ResourceArns cannot be specified simultaneously. Please provide only one of these parameters.', + ], + [ + 'errorCode' => 'NotSupport.ResourceType.ResourcesParameter', + 'errorMessage' => 'The Resources parameter does not support this resource type. Please use ResourceArns instead.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceProperties', + 'errorMessage' => 'The ResourceProperties is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceProperties.Duplicate', + 'errorMessage' => 'The ResourceProperties contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceProperties.Length', + 'errorMessage' => 'The ResourceProperties beyond the length limit.', + ], + [ + 'errorCode' => 'NotSupport.ResourceProperty', + 'errorMessage' => 'The resource type does not support resource property.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Permission', + 'errorMessage' => 'The resource share permission does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'NotEnableSharingWithResourceDirectory', + 'errorMessage' => 'You have not enabled sharing with your Resource Directory.', + ], + [ + 'errorCode' => 'AccountNotInResourceDirectory', + 'errorMessage' => 'The account is not a master or a member of a resource directory.', + ], + [ + 'errorCode' => 'QuotaExceeded.ResourceShare.Count', + 'errorMessage' => 'The maximum number of ResourceShare exceeds the limit.', + ], + [ + 'errorCode' => 'EntityAlreadyExists.ResourceShare', + 'errorMessage' => 'The specified resource share ID already exists.', + ], + [ + 'errorCode' => 'QuotaExceeded.SharedResource.Count', + 'errorMessage' => 'The maximum number of shared resources per account exceeds the limit.', + ], + [ + 'errorCode' => 'ShareWithYourself', + 'errorMessage' => 'You cannot share resources with yourself.', + ], + [ + 'errorCode' => 'NotManagementAccount', + 'errorMessage' => 'Only the management account of the service is allowed to share such resources.', + ], + [ + 'errorCode' => 'QuotaExceeded.PendingInvitations', + 'errorMessage' => 'The maximum number of pending invitations exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTarget.LegalEntityMismatch', + 'errorMessage' => 'The target account does not have the same legal entity as the resource owner account.', + ], + [ + 'errorCode' => 'ExternalTargetsNotAllowed.ResourceType', + 'errorMessage' => 'The resource share includes resource types that cannot be shared with accounts outside the resource directory.', + ], + [ + 'errorCode' => 'InvalidTarget.SiteMismatch', + 'errorMessage' => 'Cross-site resource sharing is not supported.', + ], + [ + 'errorCode' => 'NotSupport.Service.ExistInOtherResourceShare', + 'errorMessage' => 'The resource type has been shared to the target service through other resourceShare. Please share it in the same resourceShare.', + ], + [ + 'errorCode' => 'NotSupport.Service.AssociateConflict', + 'errorMessage' => 'The same resource cannot be shared repeatedly to the target service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C3FA051-61DC-4F3E-81E9-E4830524DF4B\\",\\n \\"ResourceShare\\": {\\n \\"AllowExternalTargets\\": false,\\n \\"CreateTime\\": \\"2020-12-03T08:02:22.413Z\\",\\n \\"ResourceShareId\\": \\"rs-qSkW1HBY****\\",\\n \\"ResourceShareName\\": \\"test\\",\\n \\"ResourceShareOwner\\": \\"151266687691****\\",\\n \\"ResourceShareStatus\\": \\"Active\\",\\n \\"UpdateTime\\": \\"2020-12-03T08:02:22.413Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateResourceShareResponse>\\n <RequestId>2C3FA051-61DC-4F3E-81E9-E4830524DF4B</RequestId>\\n <ResourceShare>\\n <ResourceShareId>rs-qSkW1HBY****</ResourceShareId>\\n <ResourceShareName>test</ResourceShareName>\\n <ResourceShareStatus>Active</ResourceShareStatus>\\n <CreateTime>2020-12-03T08:02:22.413Z</CreateTime>\\n <UpdateTime>2020-12-03T08:02:22.413Z</UpdateTime>\\n <ResourceShareOwner>151266687691****</ResourceShareOwner>\\n <AllowExternalTargets>false</AllowExternalTargets>\\n </ResourceShare>\\n</CreateResourceShareResponse>","errorExample":""}]', + 'title' => 'CreateResourceShare', + 'description' => 'Resource Sharing allows you to share your resources with one or more accounts and access the resources shared by other accounts. For more information, see [Resource Sharing overview](~~160622~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to create a resource share named `test` in the `cn-hangzhou` region to share the vSwitch `vsw-bp183p93qs667muql****` with the member `172050525300****` in a resource directory. In this example, the management account of the resource directory is used to call this API operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResourceShares' => [ + 'summary' => 'Queries resource shares.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the resource shares. Valid values:'."\n" + ."\n" + .'* Self: the current account'."\n" + .'* OtherAccounts: an account other than the current account'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Self', + ], + ], + [ + 'name' => 'ResourceShareName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceShareStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the resource shares. Valid values:'."\n" + ."\n" + .'* Active'."\n" + .'* Pending'."\n" + .'* Deleting'."\n" + .'* Deleted'."\n" + ."\n" + .'> The system automatically deletes the records of resource shares in the Deleted state within 48 hours to 96 hours after you delete the resource shares.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'ResourceShareIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the resource shares.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five resource shares can be specified at a time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-PqysnzIj****', + ], + 'required' => false, + 'example' => 'rs-PqysnzIj****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'PermissionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about the permissions. For more information, see [Permission library](~~465474~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz5nlvlak****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'> The tag key can be 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n" + ."\n" + .'> The tag value can be 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The `token` that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA', + ], + 'ResourceShares' => [ + 'description' => 'The information about the resource shares.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a resource share.'."\n", + 'type' => 'object', + 'properties' => [ + 'AllowExternalTargets' => [ + 'description' => 'Indicates whether resources in the resource share can be shared with accounts outside the resource directory. Valid values:'."\n" + ."\n" + .'* false: Resources in the resource share can be shared only with accounts in the resource directory.'."\n" + .'* true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource share was created.'."\n", + 'type' => 'string', + 'example' => '2020-12-03T02:20:31.292Z', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-aekz5nlvlak****', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-PqysnzIj****', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceShareOwner' => [ + 'description' => 'The owner of the resource share.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'ResourceShareStatus' => [ + 'description' => 'The status of the resource share. Valid values:'."\n" + ."\n" + .'* Active'."\n" + .'* Pending'."\n" + .'* Deleting'."\n" + .'* Deleted'."\n" + ."\n" + .'> The system automatically deletes the records of resource shares in the Deleted state within 48 hours to 96 hours after you delete the resource shares.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + 'UpdateTime' => [ + 'description' => 'The time when the resource share was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-03T08:01:43.638Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceOwner', + 'errorMessage' => 'You must specify ResourceOwner.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceOwner', + 'errorMessage' => 'The ResourceOwner is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareName', + 'errorMessage' => 'The ResourceShareName is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareName.Length', + 'errorMessage' => 'The maximum length of ResourceShareName exceeds 50 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareStatus', + 'errorMessage' => 'The ResourceShareStatus is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds', + 'errorMessage' => 'The ResourceShareIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Duplicate', + 'errorMessage' => 'The ResourceShareIds contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Length', + 'errorMessage' => 'The maximum length of ResourceShareIds exceeds 5 characters.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceOwnerAndTag', + 'errorMessage' => 'You cannot use ResourceOwner set to OtherAccounts and tags in one request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA\\",\\n \\"ResourceShares\\": [\\n {\\n \\"AllowExternalTargets\\": false,\\n \\"CreateTime\\": \\"2020-12-03T02:20:31.292Z\\",\\n \\"ResourceGroupId\\": \\"rg-aekz5nlvlak****\\",\\n \\"ResourceShareId\\": \\"rs-PqysnzIj****\\",\\n \\"ResourceShareName\\": \\"test\\",\\n \\"ResourceShareOwner\\": \\"151266687691****\\",\\n \\"ResourceShareStatus\\": \\"Active\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"UpdateTime\\": \\"2020-12-03T08:01:43.638Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceSharesResponse>\\n <ResourceShares>\\n <ResourceShareId>rs-hX9wC5jO****</ResourceShareId>\\n <ResourceShareName>test1</ResourceShareName>\\n <ResourceShareStatus>Deleted</ResourceShareStatus>\\n <CreateTime>2020-12-03T02:47:14.651Z</CreateTime>\\n <UpdateTime>2020-12-03T08:01:56.696Z</UpdateTime>\\n <ResourceShareOwner>151266687691****</ResourceShareOwner>\\n <AllowExternalTargets>false</AllowExternalTargets>\\n </ResourceShares>\\n <ResourceShares>\\n <ResourceShareId>rs-PqysnzIj****</ResourceShareId>\\n <ResourceShareName>test</ResourceShareName>\\n <ResourceShareStatus>Active</ResourceShareStatus>\\n <CreateTime>2020-12-03T02:20:31.292Z</CreateTime>\\n <UpdateTime>2020-12-03T08:01:43.638Z</UpdateTime>\\n <ResourceShareOwner>151266687691****</ResourceShareOwner>\\n <AllowExternalTargets>true</AllowExternalTargets>\\n </ResourceShares>\\n <RequestId>2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA</RequestId>\\n</ListResourceSharesResponse>","errorExample":""}]', + 'title' => 'ListResourceShares', + 'description' => 'This topic provides an example on how to call the API operation to query the resource shares that are created by using the current Alibaba Cloud account in the `cn-hangzhou` region. The response shows that the following resource shares are created within the account `151266687691****`:'."\n" + ."\n" + .'* `rs-hX9wC5jO****`, which is in the `Deleted` state'."\n" + .'* `rs-PqysnzIj****`, which is in the `Active` state'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateResourceShare' => [ + 'summary' => 'Modifies the information of a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-qSkW1HBY****', + ], + ], + [ + 'name' => 'ResourceShareName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the resource share.'."\n" + ."\n" + .'The name must be 1 to 50 characters in length.'."\n" + ."\n" + .'The name can contain letters, digits, periods (.), underscores (\\_), and hyphens (-).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'new', + ], + ], + [ + 'name' => 'AllowExternalTargets', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether resources in the resource share can be shared with accounts outside the resource directory. Valid values:'."\n" + ."\n" + .'* false: Resources in the resource share can be shared only with accounts in the resource directory.'."\n" + .'* true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2860A3A4-D8C1-4EF4-954E-84A3945E26E5', + ], + 'ResourceShare' => [ + 'description' => 'The information of the resource share.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'The time when the resource share was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-04T08:55:25.382Z', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'new', + ], + 'ResourceShareOwner' => [ + 'description' => 'The owner of the resource share.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource share was created.'."\n", + 'type' => 'string', + 'example' => '2020-12-03T08:02:22.413Z', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-qSkW1HBY****', + ], + 'ResourceShareStatus' => [ + 'description' => 'The status of the resource share. Valid values:'."\n" + ."\n" + .'* Active: The resource share is enabled.'."\n" + .'* Pending: The resource share is associated with one or more resource sharing invitations that are waiting for confirmation.'."\n" + .'* Deleting: The resource share is being deleted.'."\n" + .'* Deleted: The resource share is deleted.'."\n" + ."\n" + .'> The system deletes the records of resource shares in the Deleted state within 48 hours to 96 hours after you delete the resource shares.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'AllowExternalTargets' => [ + 'description' => 'Indicates whether resources in the resource share can be shared with accounts outside the resource directory. Valid values:'."\n" + ."\n" + .'* false: Resources in the resource share can be shared only with accounts in the resource directory.'."\n" + .'* true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceShareName', + 'errorMessage' => 'You must specify ResourceShareName.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareName', + 'errorMessage' => 'The ResourceShareName is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareName.Length', + 'errorMessage' => 'The maximum length of ResourceShareName exceeds 50 characters.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceShare', + 'errorMessage' => 'The resource share does not exist in the current account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'OperationNotPermitted', + 'errorMessage' => 'You do not have permission to do this operation.', + ], + [ + 'errorCode' => 'ResourceShareStatusMismatchAction', + 'errorMessage' => 'The status of the resource share does not allow the specified operation.', + ], + [ + 'errorCode' => 'NotSupport.AllowExternalTargets', + 'errorMessage' => 'External sharing is not permitted for resource shares with unsupported configurations.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2860A3A4-D8C1-4EF4-954E-84A3945E26E5\\",\\n \\"ResourceShare\\": {\\n \\"UpdateTime\\": \\"2020-12-04T08:55:25.382Z\\",\\n \\"ResourceShareName\\": \\"new\\",\\n \\"ResourceShareOwner\\": \\"151266687691****\\",\\n \\"CreateTime\\": \\"2020-12-03T08:02:22.413Z\\",\\n \\"ResourceShareId\\": \\"rs-qSkW1HBY****\\",\\n \\"ResourceShareStatus\\": \\"Active\\",\\n \\"AllowExternalTargets\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateResourceShareResponse>\\n <RequestId>2860A3A4-D8C1-4EF4-954E-84A3945E26E5</RequestId>\\n <ResourceShare>\\n <ResourceShareId>rs-qSkW1HBY****</ResourceShareId>\\n <ResourceShareName>new</ResourceShareName>\\n <ResourceShareStatus>Active</ResourceShareStatus>\\n <CreateTime>2020-12-03T08:02:22.413Z</CreateTime>\\n <UpdateTime>2020-12-04T08:55:25.382Z</UpdateTime>\\n <ResourceShareOwner>151266687691****</ResourceShareOwner>\\n <AllowExternalTargets>false</AllowExternalTargets>\\n </ResourceShare>\\n</UpdateResourceShareResponse>","errorExample":""}]', + 'title' => 'UpdateResourceShare', + 'description' => 'You can call this API operation to change the name or resource sharing scope of a resource share.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to change the name of the resource share `rs-qSkW1HBY****` in the `cn-hangzhou` region from `test` to `new`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteResourceShare' => [ + 'summary' => 'Deletes a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-qSkW1HBY****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A627EE2A-223D-4E1F-A954-394686AEA916', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceShare', + 'errorMessage' => 'The resource share does not exist in the current account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceShareStatusMismatchAction', + 'errorMessage' => 'The status of the resource share does not allow the specified operation.', + ], + [ + 'errorCode' => 'DeleteResourceShareConflict', + 'errorMessage' => 'You cannot delete a resource share while there are unfinished tasks.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A627EE2A-223D-4E1F-A954-394686AEA916\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteResourceShareResponse>\\r\\n\\t<RequestId>A627EE2A-223D-4E1F-A954-394686AEA916</RequestId>\\r\\n</DeleteResourceShareResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DeleteResourceShare', + 'description' => 'After a resource share is deleted, all principals in the resource share can no longer access the resources in the resource share. However, the resources are not deleted with the resource share.'."\n" + ."\n" + .'A resource share that is deleted is in the `Deleted` state. The system deletes the record of the resource share within 48 hours to 96 hours.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to delete the resource share `rs-qSkW1HBY****` in the `cn-hangzhou` region.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AssociateResourceShare' => [ + 'summary' => 'Associates resources or principals with a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-6GRmdD3X****', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The shared resource.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of a shared resource.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n" + ."\n" + .'> `Resources.N.ResourceId` and `Resources.N.ResourceType` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitch', + ], + 'ResourceId' => [ + 'description' => 'The ID of a shared resource.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time.'."\n" + ."\n" + .'> Resources.N.ResourceId and Resources.N.ResourceType must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp183p93qs667muql****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the principals.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a principal.'."\n" + ."\n" + .'* If the value of `AllowExternalTargets` for the resource share is `false`, the resource share supports only resource sharing within a resource directory. In this case, you can set this parameter to the ID of the resource directory, ID of a folder in the resource directory, or ID of a member in the resource directory.'."\n" + .'* If the value of `AllowExternalTargets` for the resource share is `true`, the resource share supports both resource sharing within a resource directory and resource sharing outside a resource directory. In this case, you can set this parameter to the ID of an independent Alibaba Cloud account, ID of the resource directory, ID of a folder in the resource directory, ID of a member in the resource directory, or the name of an Alibaba Cloud service.'."\n" + ."\n" + .'For more information, see [Resource sharing modes](~~160622~~), [View the ID of a resource directory](~~111217~~), [View the ID of a folder](~~111223~~), or [View the ID of a member](~~111624~~).'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five principals can be specified at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + 'required' => false, + 'example' => '172050525300****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceArns', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'PermissionNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the permissions. If you do not configure this parameter, the system automatically associates the default permission for the specified resource type with the resource share. For more information, see [Permission library](~~465474~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of a permission. If you do not configure this parameter, the system automatically associates the default permission for the specified resource type with the resource share. For more information, see [Permission library](~~465474~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'TargetProperties', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The properties of the principal.'."\n" + ."\n" + .'> This parameter is available only when you specify an Alibaba Cloud service as a principal.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => 'The ID of the principal.'."\n" + ."\n" + .'> `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + 'Property' => [ + 'description' => 'The property parameter of the principal. For example, you can specify a parameter that indicates the time range for resource sharing. Valid values of `timeRangeType`:'."\n" + ."\n" + .'* timeRange: a specific time range'."\n" + .'* day: all day'."\n" + ."\n" + .'> `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "timeRange":{'."\n" + .' "timeRangeType":"timeRange",'."\n" + .' "beginAtTime":"00:00",'."\n" + .' "timezone":"UTC+8",'."\n" + .' "endAtTime":"19:59"'."\n" + .' }'."\n" + .'}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceProperties', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源属性列表。', + 'type' => 'array', + 'items' => [ + 'title' => '资源属性列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'title' => '资源ARN。', + 'type' => 'string', + 'example' => 'acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****', + ], + 'Property' => [ + 'title' => '资源属性。', + 'type' => 'string', + 'example' => '{"sharePrincipals":true,"shareTagOptions":false}', + ], + ], + ], + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '111FB84A-60A9-403E-9067-E55D7EE95BD1', + ], + 'ResourceShareAssociations' => [ + 'description' => 'The information about the entities that are associated with the resource share.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the entities that are associated with the resource share.', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'The time when the association of the entity was updated. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the association of the shared resource was updated.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the time when the association of the principal was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-04T09:40:41.246Z', + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => 'The time when the association of the entity was created. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the shared resource was associated with the resource share.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the time when the principal was associated with the resource share.'."\n", + 'type' => 'string', + 'example' => '2020-12-04T09:40:41.246Z', + ], + 'EntityType' => [ + 'description' => 'The type of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of AssociationType is Resource, the value of this parameter is the type of the shared resource. For information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n" + .'* If the value of AssociationType is Target, the value of this parameter is `Account`.'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-6GRmdD3X****', + ], + 'AssociationStatusMessage' => [ + 'description' => 'The cause of the association failure.'."\n", + 'type' => 'string', + 'example' => 'The reason for the association failure.', + ], + 'AssociationType' => [ + 'description' => 'The association type. Valid values:'."\n" + ."\n" + .'* Resource'."\n" + .'* Target'."\n", + 'type' => 'string', + 'example' => 'Resource', + ], + 'AssociationStatus' => [ + 'description' => 'The association status. Valid values:'."\n" + ."\n" + .'* Associating: The entity is being associated.'."\n" + .'* Associated: The entity is associated.'."\n" + .'* Failed: The entity fails to be associated.'."\n" + .'* Disassociating: The entity is being disassociated.'."\n" + .'* Disassociated: The entity is disassociated.'."\n" + ."\n" + .'> The system deletes the records of entities in the `Failed` or `Disassociated` state within 48 hours to 96 hours.'."\n", + 'type' => 'string', + 'example' => 'Associating', + ], + 'TargetProperty' => [ + 'description' => 'The properties of the principal, such as the time range within which the resource is shared.'."\n" + ."\n" + .'> This parameter is returned only if the principal is an Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "plan":{'."\n" + .' "timeRangeType":"timeRange",'."\n" + .' "beginAtTime":"00:00",'."\n" + .' "timezone":"UTC+8",'."\n" + .' "endAtTime":"19:59"'."\n" + .' }'."\n" + .'}', + ], + 'EntityId' => [ + 'description' => 'The ID of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the ID of the shared resource.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the ID of the principal.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp183p93qs667muql****', + ], + 'ResourceProperty' => [ + 'title' => '资源属性。', + 'type' => 'string', + 'example' => '{"sharePrincipals":true,"shareTagOptions":false}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources', + 'errorMessage' => 'The Resources is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources.Duplicate', + 'errorMessage' => 'The Resources contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources.Length', + 'errorMessage' => 'The maximum number of Resources exceeds 5.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets', + 'errorMessage' => 'The Targets is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Duplicate', + 'errorMessage' => 'The Targets contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Length', + 'errorMessage' => 'The maximum number of Targets exceeds 5.', + ], + [ + 'errorCode' => 'InvalidTarget', + 'errorMessage' => 'The shared target does not exist in the resource directory.', + ], + [ + 'errorCode' => 'ResourceAndTargetBothEmpty', + 'errorMessage' => 'Either a resource or a shared target must be specified.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.PermissionNames.Duplicate', + 'errorMessage' => 'The PermissionNames duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.PermissionNames.Length', + 'errorMessage' => 'The maximum length of PermissionNames exceeds quota limit.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetProperties', + 'errorMessage' => 'The TargetProperties is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetProperties.Duplicate', + 'errorMessage' => 'The TargetProperties contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.TargetProperties.Length', + 'errorMessage' => 'The TargetProperties beyond the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns', + 'errorMessage' => 'The ResourceArns is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Duplicate', + 'errorMessage' => 'The ResourceArns contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Length', + 'errorMessage' => 'The ResourceArns beyond the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceConflict', + 'errorMessage' => 'Both Resources and ResourceArns cannot be specified simultaneously. Please provide only one of these parameters.', + ], + [ + 'errorCode' => 'NotSupport.ResourceType.ResourcesParameter', + 'errorMessage' => 'The Resources parameter does not support this resource type. Please use ResourceArns instead.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceProperties', + 'errorMessage' => 'The ResourceProperties is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceProperties.Duplicate', + 'errorMessage' => 'The ResourceProperties contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceProperties.Length', + 'errorMessage' => 'The ResourceProperties beyond the length limit.', + ], + [ + 'errorCode' => 'NotSupport.ResourceProperty', + 'errorMessage' => 'The resource type does not support resource property.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceShare', + 'errorMessage' => 'The resource share does not exist in the current account.', + ], + [ + 'errorCode' => 'EntityNotExists.Permission', + 'errorMessage' => 'The resource share permission does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'NotEnableSharingWithResourceDirectory', + 'errorMessage' => 'You have not enabled sharing with your Resource Directory.', + ], + [ + 'errorCode' => 'AccountNotInResourceDirectory', + 'errorMessage' => 'The account is not a master or a member of a resource directory.', + ], + [ + 'errorCode' => 'ResourceShareStatusMismatchAction', + 'errorMessage' => 'The status of the resource share does not allow the specified operation.', + ], + [ + 'errorCode' => 'QuotaExceeded.SharedResource.Count', + 'errorMessage' => 'The maximum number of shared resources per account exceeds the limit.', + ], + [ + 'errorCode' => 'ShareWithYourself', + 'errorMessage' => 'You cannot share resources with yourself.', + ], + [ + 'errorCode' => 'AssociateConflict', + 'errorMessage' => 'You cannot perform the operation while disassociation operation is being performed.', + ], + [ + 'errorCode' => 'NotManagementAccount', + 'errorMessage' => 'Only the management account of the service is allowed to share such resources.', + ], + [ + 'errorCode' => 'QuotaExceeded.PendingInvitations', + 'errorMessage' => 'The maximum number of pending invitations exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTarget.LegalEntityMismatch', + 'errorMessage' => 'The target account does not have the same legal entity as the resource owner account.', + ], + [ + 'errorCode' => 'ExternalTargetsNotAllowed.ResourceType', + 'errorMessage' => 'The resource share includes resource types that cannot be shared with accounts outside the resource directory.', + ], + [ + 'errorCode' => 'InvalidTarget.SiteMismatch', + 'errorMessage' => 'Cross-site resource sharing is not supported.', + ], + [ + 'errorCode' => 'NotSupport.Service.ExistInOtherResourceShare', + 'errorMessage' => 'The resource type has been shared to the target service through other resourceShare. Please share it in the same resourceShare.', + ], + [ + 'errorCode' => 'NotSupport.Service.AssociateConflict', + 'errorMessage' => 'The same resource cannot be shared repeatedly to the target service.', + ], + [ + 'errorCode' => 'NotSupport.ResourcePropertyConflict', + 'errorMessage' => 'The ResourceProperty can not be updated until the last operation is completed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"111FB84A-60A9-403E-9067-E55D7EE95BD1\\",\\n \\"ResourceShareAssociations\\": [\\n {\\n \\"UpdateTime\\": \\"2020-12-04T09:40:41.246Z\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"ResourceShareName\\": \\"test\\",\\n \\"CreateTime\\": \\"2020-12-04T09:40:41.246Z\\",\\n \\"EntityType\\": \\"VSwitch\\",\\n \\"ResourceShareId\\": \\"rs-6GRmdD3X****\\",\\n \\"AssociationStatusMessage\\": \\"The reason for the association failure.\\",\\n \\"AssociationType\\": \\"Resource\\",\\n \\"AssociationStatus\\": \\"Associating\\",\\n \\"TargetProperty\\": \\"{\\\\n \\\\\\"plan\\\\\\":{\\\\n \\\\\\"timeRangeType\\\\\\":\\\\\\"timeRange\\\\\\",\\\\n \\\\\\"beginAtTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\":\\\\\\"UTC+8\\\\\\",\\\\n \\\\\\"endAtTime\\\\\\":\\\\\\"19:59\\\\\\"\\\\n }\\\\n}\\",\\n \\"EntityId\\": \\"vsw-bp183p93qs667muql****\\",\\n \\"ResourceProperty\\": \\"{\\\\\\"sharePrincipals\\\\\\":true,\\\\\\"shareTagOptions\\\\\\":false}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<AssociateResourceShareResponse>\\r\\n\\t<ResourceShareAssociations>\\r\\n\\t\\t<ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\r\\n\\t\\t<EntityId>vsw-bp183p93qs667muql****</EntityId>\\r\\n\\t\\t<EntityType>VSwitch</EntityType>\\r\\n\\t\\t<AssociationStatusMessage></AssociationStatusMessage>\\r\\n\\t\\t<AssociationType>Resource</AssociationType>\\r\\n\\t\\t<CreateTime>2020-12-04T09:40:41.246Z</CreateTime>\\r\\n\\t\\t<UpdateTime>2020-12-04T09:40:41.246Z</UpdateTime>\\r\\n\\t\\t<ResourceShareName>test</ResourceShareName>\\r\\n\\t\\t<AssociationStatus>Associating</AssociationStatus>\\r\\n\\t</ResourceShareAssociations>\\r\\n\\t<ResourceShareAssociations>\\r\\n\\t\\t<ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\r\\n\\t\\t<EntityId>172050525300****</EntityId>\\r\\n\\t\\t<EntityType>Account</EntityType>\\r\\n\\t\\t<AssociationStatusMessage></AssociationStatusMessage>\\r\\n\\t\\t<AssociationType>Target</AssociationType>\\r\\n\\t\\t<CreateTime>2020-12-04T09:40:41.250Z</CreateTime>\\r\\n\\t\\t<UpdateTime>2020-12-04T09:40:41.250Z</UpdateTime>\\r\\n\\t\\t<ResourceShareName>test1</ResourceShareName>\\r\\n\\t\\t<AssociationStatus>Associating</AssociationStatus>\\r\\n\\t</ResourceShareAssociations>\\r\\n\\t<RequestId>111FB84A-60A9-403E-9067-E55D7EE95BD1</RequestId>\\r\\n</AssociateResourceShareResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'AssociateResourceShare', + 'description' => 'This topic provides an example on how to call the API operation to associate the vSwitch `vsw-bp183p93qs667muql****` and the member `172050525300****` with the resource share `rs-6GRmdD3X****` in the `cn-hangzhou` region. After the association, the vSwitch is shared with the member.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisassociateResourceShare' => [ + 'summary' => 'Disassociates resources or principals from a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-6GRmdD3X****', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The shared resource.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of a shared resource.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n" + ."\n" + .'> Resources.N.ResourceId and Resources.N.ResourceType must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitch', + ], + 'ResourceId' => [ + 'description' => 'The ID of the shared resource.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time.'."\n" + ."\n" + .'> Resources.N.ResourceId and Resources.N.ResourceType must be used in pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp183p93qs667muql****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the principals.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the principals.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five principals can be specified at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + 'required' => false, + 'example' => '172050525300****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceArns', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the resource share. Valid values:'."\n" + ."\n" + .'* Self: The resource share belongs to the current account. This is the default value. For resource sharing within a resource directory, if you are a resource owner and you want to disassociate resources or principals from a resource share, set this parameter to Self.'."\n" + .'* OtherAccounts: The resource share belongs to another account. For resource sharing outside a resource directory, if you are a principal and you want to exit a resource share, set this parameter to OtherAccounts.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Self', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '95230BC9-A8E8-4493-96BD-4F0C758E37F8', + ], + 'ResourceShareAssociations' => [ + 'description' => 'The information about the entities that are associated with the resource share.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the entities that are associated with the resource share.', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'The time when the disassociation of the entity was updated. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the disassociation of the resource was updated.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the time when the disassociation of the principal was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-04T09:40:45.556Z', + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => 'The time when the disassociation of the entity was performed. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the resource was disassociated from the resource share.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the time when the principal was disassociated from the resource share.'."\n", + 'type' => 'string', + 'example' => '2020-12-04T09:40:41.250Z', + ], + 'EntityType' => [ + 'description' => 'The type of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of AssociationType is Resource, the value of this parameter is the type of the resource. For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n" + .'* If the value of AssociationType is Target, the value of this parameter is Account.'."\n", + 'type' => 'string', + 'example' => 'Account', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-6GRmdD3X****', + ], + 'AssociationStatusMessage' => [ + 'description' => 'The cause of the disassociation failure.'."\n", + 'type' => 'string', + 'example' => 'The Resources is invalid.', + ], + 'AssociationType' => [ + 'description' => 'The association type. Valid values:'."\n" + ."\n" + .'* Resource'."\n" + .'* Target'."\n", + 'type' => 'string', + 'example' => 'Target', + ], + 'AssociationStatus' => [ + 'description' => 'The association status. Valid values:'."\n" + ."\n" + .'* Associating: The entity is being associated.'."\n" + .'* Associated: The entity is associated.'."\n" + .'* Failed: The entity fails to be associated.'."\n" + .'* Disassociating: The entity is being disassociated.'."\n" + .'* Disassociated: The entity is disassociated.'."\n" + ."\n" + .'> The system deletes the records of entities in the `Failed` or `Disassociated` state within 48 hours to 96 hours.'."\n", + 'type' => 'string', + 'example' => 'Disassociating', + ], + 'TargetProperty' => [ + 'description' => 'The properties of the principal, such as the time range within which the resource is shared.'."\n" + ."\n" + .'> This parameter is returned only if the principal is an Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "timeRange":{'."\n" + .' "timeRangeType":"timeRange",'."\n" + .' "beginAtTime":"00:00",'."\n" + .' "timezone":"UTC+8",'."\n" + .' "endAtTime":"19:59"'."\n" + .' }'."\n" + .'}', + ], + 'EntityId' => [ + 'description' => 'The ID of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the ID of the resource.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the ID of the resource directory, folder, member, or Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => '172050525300****', + ], + 'ResourceProperty' => [ + 'title' => '资源属性。', + 'type' => 'string', + 'example' => '{"sharePrincipals":true,"shareTagOptions":false}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources', + 'errorMessage' => 'The Resources is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources.Duplicate', + 'errorMessage' => 'The Resources contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Resources.Length', + 'errorMessage' => 'The maximum number of Resources exceeds 5.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets', + 'errorMessage' => 'The Targets is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Duplicate', + 'errorMessage' => 'The Targets contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Length', + 'errorMessage' => 'The maximum number of Targets exceeds 5.', + ], + [ + 'errorCode' => 'ResourceAndTargetBothEmpty', + 'errorMessage' => 'Either a resource or a shared target must be specified.', + ], + [ + 'errorCode' => 'DisassociateInvalid', + 'errorMessage' => 'You can not disassociate unassociated resource or target.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns', + 'errorMessage' => 'The ResourceArns is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Duplicate', + 'errorMessage' => 'The ResourceArns contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Length', + 'errorMessage' => 'The ResourceArns beyond the length limit.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceConflict', + 'errorMessage' => 'Both Resources and ResourceArns cannot be specified simultaneously. Please provide only one of these parameters.', + ], + [ + 'errorCode' => 'NotSupport.ResourceType.ResourcesParameter', + 'errorMessage' => 'The Resources parameter does not support this resource type. Please use ResourceArns instead.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceShare', + 'errorMessage' => 'The resource share does not exist in the current account.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AccountNotInResourceDirectory', + 'errorMessage' => 'The account is not a master or a member of a resource directory.', + ], + [ + 'errorCode' => 'ResourceShareStatusMismatchAction', + 'errorMessage' => 'The status of the resource share does not allow the specified operation.', + ], + [ + 'errorCode' => 'DisassociateConflict', + 'errorMessage' => 'You cannot perform the operation while association is already in progress.', + ], + [ + 'errorCode' => 'LeavingFailed.Account', + 'errorMessage' => 'The account was added to the resource share automatically by resoucre directory.', + ], + [ + 'errorCode' => 'LeavingFailed.ResourceType', + 'errorMessage' => 'The resource share contains resources of the resource types that dont support this action.', + ], + [ + 'errorCode' => 'ExternalTargetWithdrawConflict', + 'errorMessage' => 'Existing internal association task in resource directory when disassociating with resource share.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95230BC9-A8E8-4493-96BD-4F0C758E37F8\\",\\n \\"ResourceShareAssociations\\": [\\n {\\n \\"UpdateTime\\": \\"2020-12-04T09:40:45.556Z\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"ResourceShareName\\": \\"test\\",\\n \\"CreateTime\\": \\"2020-12-04T09:40:41.250Z\\",\\n \\"EntityType\\": \\"Account\\",\\n \\"ResourceShareId\\": \\"rs-6GRmdD3X****\\",\\n \\"AssociationStatusMessage\\": \\"The Resources is invalid.\\",\\n \\"AssociationType\\": \\"Target\\",\\n \\"AssociationStatus\\": \\"Disassociating\\",\\n \\"TargetProperty\\": \\"{\\\\n \\\\\\"timeRange\\\\\\":{\\\\n \\\\\\"timeRangeType\\\\\\":\\\\\\"timeRange\\\\\\",\\\\n \\\\\\"beginAtTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\":\\\\\\"UTC+8\\\\\\",\\\\n \\\\\\"endAtTime\\\\\\":\\\\\\"19:59\\\\\\"\\\\n }\\\\n}\\",\\n \\"EntityId\\": \\"172050525300****\\",\\n \\"ResourceProperty\\": \\"{\\\\\\"sharePrincipals\\\\\\":true,\\\\\\"shareTagOptions\\\\\\":false}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DisassociateResourceShareResponse>\\r\\n\\t<ResourceShareAssociations>\\r\\n\\t\\t<ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\r\\n\\t\\t<EntityId>172050525300****</EntityId>\\r\\n\\t\\t<EntityType>Account</EntityType>\\r\\n\\t\\t<AssociationStatusMessage></AssociationStatusMessage>\\r\\n\\t\\t<AssociationType>Target</AssociationType>\\r\\n\\t\\t<CreateTime>2020-12-04T09:40:41.250Z</CreateTime>\\r\\n\\t\\t<UpdateTime>2020-12-04T09:40:45.556Z</UpdateTime>\\r\\n <ResourceShareName>test</ResourceShareName>\\r\\n\\t\\t<AssociationStatus>Disassociating</AssociationStatus>\\r\\n\\t</ResourceShareAssociations>\\r\\n\\t<RequestId>95230BC9-A8E8-4493-96BD-4F0C758E37F8</RequestId>\\r\\n</DisassociateResourceShareResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DisassociateResourceShare', + 'description' => '* A resource owner can call this API operation to disassociate shared resources or principals from a resource share.'."\n" + .'* If a principal does not belong to a resource directory, the principal can call this API operation to exit the resource share. For more information, see [Exit a resource share](~~440614~~).'."\n" + ."\n" + .'This topic provides an example on how to use the management account of a resource directory to call the API operation to disassociate the member `172050525300****` from the resource share `rs-6GRmdD3X****` in the `cn-hangzhou` region. After the member is disassociated from the resource share, the member cannot share the resources in the resource share.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResourceShareAssociations' => [ + 'summary' => 'Queries the association records of resource shares.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource.'."\n" + ."\n" + .'> This parameter is unavailable if you set the `AssociationType` parameter to `Target`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp183p93qs667muql****', + ], + ], + [ + 'name' => 'ResourceArn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the principal.'."\n" + ."\n" + .'> This parameter is unavailable if you set the `AssociationType` parameter to `Resource`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + ], + [ + 'name' => 'AssociationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The association type. Valid values:'."\n" + ."\n" + .'* Resource'."\n" + .'* Target'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Resource', + ], + ], + [ + 'name' => 'AssociationStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The association status. Valid values:'."\n" + ."\n" + .'* Associating: The entity is being associated.'."\n" + .'* Associated: The entity is associated.'."\n" + .'* Failed: The entity fails to be associated.'."\n" + .'* Disassociating: The entity is being disassociated.'."\n" + .'* Disassociated: The entity is disassociated.'."\n" + ."\n" + .'> The system deletes the records of entities in the `Failed` or `Disassociated` state within 48 hours to 96 hours.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Associated', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'ResourceShareIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the resource shares.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five resource shares can be specified at a time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-6GRmdD3X****', + ], + 'required' => false, + 'example' => 'rs-6GRmdD3X****', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The `token` that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB', + ], + 'ResourceShareAssociations' => [ + 'description' => 'The information of the entities.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of an entity.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'The time when the association of the entity was updated. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the association of the shared resource was updated.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the time when the association of the principal was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:02.920Z', + ], + 'EntityId' => [ + 'description' => 'The ID of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the ID of the resource.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the ID of the principal.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1upw03qyz8n7us9****', + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + 'CreateTime' => [ + 'description' => 'The time when the association of the entity was created. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the shared resource was associated with or disassociated from the resource share.'."\n" + .'* If the value of `AssociationType` is `Target`, the value of this parameter is the time when the principal was associated with or disassociated from the resource share.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'EntityType' => [ + 'description' => 'The type of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of AssociationType is Resource, the value of this parameter is the type of the resource. For information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n" + .'* If the value of AssociationType is Target, the value of this parameter is `Account`.'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-6GRmdD3X****', + ], + 'AssociationStatusMessage' => [ + 'description' => 'The cause of the association failure.'."\n", + 'type' => 'string', + 'example' => 'The reason for the association failure. ', + ], + 'AssociationType' => [ + 'description' => 'The association type. Valid values:'."\n" + ."\n" + .'* Resource'."\n" + .'* Target'."\n", + 'type' => 'string', + 'example' => 'Resource', + ], + 'AssociationStatus' => [ + 'description' => 'The association status. Valid values:'."\n" + ."\n" + .'* Associating: The entity is being associated.'."\n" + .'* Associated: The entity is associated.'."\n" + .'* Failed: The entity fails to be associated.'."\n" + .'* Disassociating: The entity is being disassociated.'."\n" + .'* Disassociated: The entity is disassociated.'."\n" + ."\n" + .'> The system deletes the records of entities in the `Failed` or `Disassociated` state within 48 hours to 96 hours.'."\n", + 'type' => 'string', + 'example' => 'Associated', + ], + 'External' => [ + 'description' => 'Indicates whether the principal is outside the resource directory. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'AssociationFailedDetails' => [ + 'description' => 'The information about the failure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the failure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'This parameter is deprecated. The FailureReason parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'StatusMessage' => [ + 'description' => 'This parameter is deprecated. The FailureDescription parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'AssociateType' => [ + 'description' => 'This parameter is deprecated. The OperationType parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'EntityType' => [ + 'description' => 'The type of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of AssociationType is Resource, the value of this parameter is the type of the resource. For information about the types of resources that can be shared, see Services that work with Resource Sharing.'."\n" + .'* If the value of AssociationType is Target, the value of this parameter is `ResourceDirectory`, `Folder`, `Account`, or `Service`.'."\n", + 'type' => 'string', + 'example' => 'Account', + ], + 'FailureReason' => [ + 'description' => 'The failure cause. Valid values:'."\n" + ."\n" + .'* Unavailable: The resource does not exist.'."\n" + .'* LimitExceeded: The number of principals for the resource exceeds the upper limit.'."\n" + .'* ZonalResourceInaccessible: The resource is unavailable in this region.'."\n" + .'* InternalError: An internal error occurred.'."\n" + .'* UnsupportedOperation: You cannot perform this operation.'."\n", + 'type' => 'string', + 'example' => 'Unavailable', + ], + 'FailureDescription' => [ + 'description' => 'The failure description.'."\n", + 'type' => 'string', + 'example' => 'You cannot access the specified resource at this time.', + ], + 'OperationType' => [ + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'* Associate'."\n" + .'* Disassociate'."\n", + 'type' => 'string', + 'example' => 'Associate', + ], + 'EntityId' => [ + 'description' => 'The ID of the entity. The value of this parameter depends on the value of the AssociationType parameter:'."\n" + ."\n" + .'* If the value of AssociationType is Resource, the value of this parameter is the ID of the principal.'."\n" + .'* If the value of AssociationType is Target, the value of this parameter is the ID of the resource.'."\n", + 'type' => 'string', + 'example' => '172050525300****', + ], + ], + ], + ], + 'TargetProperty' => [ + 'description' => 'The properties of the principal, such as the time range within which the resource is shared. Valid values of `timeRangeType`:'."\n" + ."\n" + .'* timeRange: a specific time range'."\n" + .'* day: all day'."\n" + ."\n" + .'> This parameter is returned only if the principal is an Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "timeRange":{'."\n" + .' "timeRangeType":"timeRange",'."\n" + .' "beginAtTime":"00:00",'."\n" + .' "timezone":"UTC+8",'."\n" + .' "endAtTime":"19:59"'."\n" + .' }'."\n" + .'}', + ], + 'ResourceProperty' => [ + 'title' => '资源属性。', + 'type' => 'string', + 'example' => '{"sharePrincipals":true,"shareTagOptions":false}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.AssociationType', + 'errorMessage' => 'You must specify AssociationType.', + ], + [ + 'errorCode' => 'InvalidParameter.AssociationType', + 'errorMessage' => 'The AssociationType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.AssociationStatus', + 'errorMessage' => 'The AssociationStatus is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds', + 'errorMessage' => 'The ResourceShareIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Duplicate', + 'errorMessage' => 'The ResourceShareIds contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Length', + 'errorMessage' => 'The maximum length of ResourceShareIds exceeds 5 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.Target', + 'errorMessage' => 'The Target is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The ResourceId is invalid.', + ], + [ + 'errorCode' => 'ConflictedAssociationType', + 'errorMessage' => 'The specified ResourceId or Target conflicts with AssociationType.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArn', + 'errorMessage' => 'The ResourceArn is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceConflict', + 'errorMessage' => 'Both ResourceId and ResourceArn cannot be specified simultaneously. Please provide only one of these parameters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB\\",\\n \\"ResourceShareAssociations\\": [\\n {\\n \\"UpdateTime\\": \\"2020-12-07T07:39:02.920Z\\",\\n \\"EntityId\\": \\"vsw-bp1upw03qyz8n7us9****\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"ResourceShareName\\": \\"example\\",\\n \\"CreateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"EntityType\\": \\"VSwitch\\",\\n \\"ResourceShareId\\": \\"rs-6GRmdD3X****\\",\\n \\"AssociationStatusMessage\\": \\"The reason for the association failure. \\",\\n \\"AssociationType\\": \\"Resource\\",\\n \\"AssociationStatus\\": \\"Failed\\",\\n \\"External\\": false,\\n \\"AssociationFailedDetails\\": [\\n {\\n \\"Status\\": \\"无\\",\\n \\"StatusMessage\\": \\"无\\",\\n \\"AssociateType\\": \\"无\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"EntityType\\": \\"Account\\",\\n \\"FailureReason\\": \\"Unavailable\\",\\n \\"FailureDescription\\": \\"You cannot access the specified resource at this time.\\",\\n \\"OperationType\\": \\"Associate\\",\\n \\"EntityId\\": \\"172050525300****\\"\\n }\\n ],\\n \\"TargetProperty\\": \\"{\\\\n \\\\\\"timeRange\\\\\\":{\\\\n \\\\\\"timeRangeType\\\\\\":\\\\\\"timeRange\\\\\\",\\\\n \\\\\\"beginAtTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\":\\\\\\"UTC+8\\\\\\",\\\\n \\\\\\"endAtTime\\\\\\":\\\\\\"19:59\\\\\\"\\\\n }\\\\n}\\",\\n \\"ResourceProperty\\": \\"{\\\\\\"sharePrincipals\\\\\\":true,\\\\\\"shareTagOptions\\\\\\":false}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceShareAssociationsResponse>\\n <ResourceShareAssociations>\\n <ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\n <ResourceShareName>example</ResourceShareName>\\n <EntityId>vsw-bp1upw03qyz8n7us9****</EntityId>\\n <EntityType>VSwitch</EntityType>\\n <AssociationStatusMessage/>\\n <AssociationType>Resource</AssociationType>\\n <CreateTime>2020-12-07T07:39:01.818Z</CreateTime>\\n <UpdateTime>2020-12-07T07:39:02.920Z</UpdateTime>\\n <External>false</External>\\n <AssociationStatus>Associated</AssociationStatus>\\n </ResourceShareAssociations>\\n <ResourceShareAssociations>\\n <ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\n <ResourceShareName>example</ResourceShareName>\\n <EntityId>vsw-bp183p93qs667muql****</EntityId>\\n <EntityType>VSwitch</EntityType>\\n <AssociationStatusMessage/>\\n <AssociationType>Resource</AssociationType>\\n <CreateTime>2020-12-04T09:40:41.246Z</CreateTime>\\n <UpdateTime>2020-12-07T03:17:24.067Z</UpdateTime>\\n <External>false</External>\\n <AssociationStatus>Disassociated</AssociationStatus>\\n </ResourceShareAssociations>\\n <RequestId>11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB</RequestId>\\n</ListResourceShareAssociationsResponse>","errorExample":""}]', + 'title' => 'ListResourceShareAssociations', + 'description' => 'This topic provides an example on how to call the API operation to query the association records of the resource shares that are created by using the current Alibaba Cloud account in the `cn-hangzhou` region. The response shows the following records:'."\n" + ."\n" + .'* The resource `vsw-bp1upw03qyz8n7us9****` of the `VSwitch` type has been associated with the resource share `rs-6GRmdD3X****`. The resource is in the `Associated` state. This indicates that the resource is being shared.'."\n" + .'* The resource `vsw-bp183p93qs667muql****` of the `VSwitch` type has been disassociated from the resource share `rs-6GRmdD3X****`. The resource is in the `Disassociated` state. This indicates that the sharing of the resource is stopped.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSharedResources' => [ + 'summary' => 'Queries the resources you share with other accounts or the resources other accounts share with you.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the resource shares. Valid values:'."\n" + ."\n" + .'* Self: your account. If you set the value to Self, the resources you share with other accounts are queried.'."\n" + .'* OtherAccounts: another account. If you set the value to OtherAccounts, the resources other accounts share with you are queried.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Self', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitch', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the principal or resource owner.'."\n" + ."\n" + .'* If the value of `ResourceOwner` is `Self`, set this parameter to the ID of a principal.'."\n" + .'* If the value of `ResourceOwner` is `OtherAccounts`, set this parameter to the ID of a resource owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172050525300****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'ResourceShareIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of a resource share.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-6GRmdD3X****', + ], + 'required' => false, + 'example' => 'rs-6GRmdD3X****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of a shared resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a shared resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1upw03qyz8n7us9****', + ], + 'required' => false, + 'example' => 'vsw-bp1upw03qyz8n7us9****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceArns', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04677DCA-7C33-464B-8811-1B1DA3C3D197', + ], + 'SharedResources' => [ + 'description' => 'The information of the shared resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the shared resources.', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'The time when the association of the shared resource was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:02.921Z', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resource.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'CreateTime' => [ + 'description' => 'The time when the shared resource was associated with the resource share.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:02.921Z', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-6GRmdD3X****', + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'ResourceStatus' => [ + 'description' => 'The status of the shared resource. This parameter is returned only when you query the resources that other accounts share with you.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Available: The resource is available.'."\n" + .'* ZonalResourceInaccessible: The resource is unavailable in the current zone.'."\n" + .'* LimitExceeded: The resource is unavailable because the maximum number of resources that other accounts can share with you exceeds the upper limit.'."\n" + .'* Unavailable: The resource is unavailable.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'ResourceStatusMessage' => [ + 'description' => 'The cause of the association failure.'."\n", + 'type' => 'string', + 'example' => 'The reason for the association failure. ', + ], + 'ResourceId' => [ + 'description' => 'The ID of the shared resource.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1upw03qyz8n7us9****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceOwner', + 'errorMessage' => 'You must specify ResourceOwner.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceOwner', + 'errorMessage' => 'The ResourceOwner is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds', + 'errorMessage' => 'The ResourceShareIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Duplicate', + 'errorMessage' => 'The ResourceShareIds contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Length', + 'errorMessage' => 'The maximum length of ResourceShareIds exceeds 5 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceIds', + 'errorMessage' => 'The ResourceIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceIds.Duplicate', + 'errorMessage' => 'The specified ResourceId contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceIds.Length', + 'errorMessage' => 'The maximum number of ResourceIds (5) is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.Target', + 'errorMessage' => 'The Target is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns', + 'errorMessage' => 'The ResourceArns is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Duplicate', + 'errorMessage' => 'The ResourceArns contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArns.Length', + 'errorMessage' => 'The ResourceArns beyond the length limit.', + ], + [ + 'errorCode' => 'NotSupport.ResourceType.ResourcesParameter', + 'errorMessage' => 'The Resources parameter does not support this resource type. Please use ResourceArns instead.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceConflict', + 'errorMessage' => 'Both ResourceId and ResourceArn cannot be specified simultaneously. Please provide only one of these parameters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"04677DCA-7C33-464B-8811-1B1DA3C3D197\\",\\n \\"SharedResources\\": [\\n {\\n \\"UpdateTime\\": \\"2020-12-07T07:39:02.921Z\\",\\n \\"ResourceType\\": \\"VSwitch\\",\\n \\"CreateTime\\": \\"2020-12-07T07:39:02.921Z\\",\\n \\"ResourceShareId\\": \\"rs-6GRmdD3X****\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"ResourceStatus\\": \\"Available\\",\\n \\"ResourceStatusMessage\\": \\"The reason for the association failure. \\",\\n \\"ResourceId\\": \\"vsw-bp1upw03qyz8n7us9****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListSharedResourcesResponse>\\r\\n\\t<RequestId>04677DCA-7C33-464B-8811-1B1DA3C3D197</RequestId>\\r\\n\\t<SharedResources>\\r\\n\\t\\t<ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\r\\n\\t\\t<ResourceId>vsw-bp1upw03qyz8n7us9****</ResourceId>\\r\\n\\t\\t<CreateTime>2020-12-07T07:39:02.921Z</CreateTime>\\r\\n\\t\\t<UpdateTime>2020-12-07T07:39:02.921Z</UpdateTime>\\r\\n\\t\\t<ResourceType>VSwitch</ResourceType>\\r\\n\\t</SharedResources>\\r\\n</ListSharedResourcesResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListSharedResources', + 'description' => 'This topic provides an example on how to call the API operation to query the resources that you share with other accounts in the `cn-hangzhou` region. The response shows that in the resource share `rs-6GRmdD3X****`, you share the `vsw-bp1upw03qyz8n7us9****` resource of the `VSwitch` type with other accounts.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSharedTargets' => [ + 'summary' => 'Queries principals.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the resource share.'."\n" + ."\n" + .'* Self: your account. If you set the value to Self, the principals that are associated with your resource shares are queried.'."\n" + .'* OtherAccounts: another account. If you set the value to OtherAccounts, the resource shares with which your account is associated and the owners of the resource shares are queried.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Self', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitch', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shared resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1upw03qyz8n7us9****', + ], + ], + [ + 'name' => 'ResourceArn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'ResourceShareIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of a resource share.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five resource shares can be specified at a time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource share.'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five resource shares can be specified at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-6GRmdD3X****', + ], + 'required' => false, + 'example' => 'rs-6GRmdD3X****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the principals.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a principal.'."\n" + ."\n" + .'* If the value of `AllowExternalTargets` is `false`, you can set this parameter to the ID of a resource directory, folder, or member.'."\n" + .'* If the value of `AllowExternalTargets` is `true`, you can set this parameter to the ID of an Alibaba Cloud account, resource directory, folder, or member or the name of an Alibaba Cloud service.'."\n" + ."\n" + .'For more information, see [Resource sharing modes](~~160622~~), [View the ID of a resource directory](~~111217~~), [View the ID of a folder](~~111223~~), or [View the ID of a member](~~111624~~).'."\n" + ."\n" + .'Valid values of N: 1 to 5. This indicates that a maximum of five principals can be specified at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '114240524784****', + ], + 'required' => false, + 'example' => '114240524784****', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04677DCA-7C33-464B-8811-1B1DA3C3D197', + ], + 'SharedTargets' => [ + 'description' => 'The information of the principals.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the principals.', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => 'The ID of the principal or resource owner.'."\n" + ."\n" + .'* If the value of `ResourceOwner` is `Self`, the value of this parameter is the ID of a principal.'."\n" + .'* If the value of `ResourceOwner` is `OtherAccounts`, the value of this parameter is the ID of a resource owner.'."\n", + 'type' => 'string', + 'example' => '114240524784****', + ], + 'UpdateTime' => [ + 'description' => 'The time when the association of the principal was updated.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T09:16:59.905Z', + ], + 'CreateTime' => [ + 'description' => 'The time when the principal was associated with the resource share.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T09:16:59.905Z', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-6GRmdD3X****', + ], + 'External' => [ + 'description' => 'Indicates whether the principal is outside the resource directory. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'TargetProperty' => [ + 'description' => 'The properties of the principal, such as the time range within which the resource is shared.'."\n" + ."\n" + .'> This parameter is returned only if the principal is an Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "timeRange":{'."\n" + .' "timeRangeType":"timeRange",'."\n" + .' "beginAtTime":"00:00",'."\n" + .' "timezone":"UTC+8",'."\n" + .' "endAtTime":"19:59"'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceOwner', + 'errorMessage' => 'You must specify ResourceOwner.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceOwner', + 'errorMessage' => 'The ResourceOwner is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds', + 'errorMessage' => 'The ResourceShareIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Duplicate', + 'errorMessage' => 'The ResourceShareIds contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Length', + 'errorMessage' => 'The maximum length of ResourceShareIds exceeds 5 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets', + 'errorMessage' => 'The Targets is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Duplicate', + 'errorMessage' => 'The Targets contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.Targets.Length', + 'errorMessage' => 'The maximum number of Targets exceeds 5.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The ResourceId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceArn', + 'errorMessage' => 'The ResourceArn is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceConflict', + 'errorMessage' => 'Both ResourceId and ResourceArn cannot be specified simultaneously. Please provide only one of these parameters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"04677DCA-7C33-464B-8811-1B1DA3C3D197\\",\\n \\"SharedTargets\\": [\\n {\\n \\"TargetId\\": \\"114240524784****\\",\\n \\"UpdateTime\\": \\"2020-12-07T09:16:59.905Z\\",\\n \\"CreateTime\\": \\"2020-12-07T09:16:59.905Z\\",\\n \\"ResourceShareId\\": \\"rs-6GRmdD3X****\\",\\n \\"External\\": false,\\n \\"TargetProperty\\": \\"{\\\\n \\\\\\"timeRange\\\\\\":{\\\\n \\\\\\"timeRangeType\\\\\\":\\\\\\"timeRange\\\\\\",\\\\n \\\\\\"beginAtTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\":\\\\\\"UTC+8\\\\\\",\\\\n \\\\\\"endAtTime\\\\\\":\\\\\\"19:59\\\\\\"\\\\n }\\\\n}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSharedTargetsResponse>\\n <RequestId>445ECACB-1082-4008-ABD4-8B259EFF4855</RequestId>\\n <SharedTargets>\\n <ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\n <CreateTime>2020-12-07T09:16:59.905Z</CreateTime>\\n <UpdateTime>2020-12-07T09:16:59.905Z</UpdateTime>\\n <External>false</External>\\n <TargetId>114240524784****</TargetId>\\n </SharedTargets>\\n <SharedTargets>\\n <ResourceShareId>rs-6GRmdD3X****</ResourceShareId>\\n <CreateTime>2020-12-07T09:15:26.879Z</CreateTime>\\n <UpdateTime>2020-12-07T09:15:26.879Z</UpdateTime>\\n <External>false</External>\\n <TargetId>172050525300****</TargetId>\\n </SharedTargets>\\n</ListSharedTargetsResponse>","errorExample":""}]', + 'title' => 'ListSharedTargets', + 'description' => 'If you are a resource owner, you can query the principals with which you share your resources. If you are a principal, you can query the resources that are shared with you.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the principals with which you share your resources in the `cn-hangzhou` region. The response shows that you share your resources with the principals `114240524784****` and `172050525300****`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the regions where the Resource Sharing service is available.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The supported natural language. Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese'."\n" + .'* en-US: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0D64A198-5842-4570-8E26-5E540CDC84CD', + ], + 'Regions' => [ + 'description' => 'The information of the regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the regions.', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the Resource Sharing service in the region.'."\n", + 'type' => 'string', + 'example' => 'resourcesharing.cn-hangzhou.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D64A198-5842-4570-8E26-5E540CDC84CD\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"resourcesharing.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>9BF57A2D-5108-58A1-BF2B-812BB4026666</RequestId>\\n <Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>resourcesharing.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1（杭州）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>resourcesharing.cn-shanghai.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2（上海）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>resourcesharing.cn-qingdao.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1（青岛）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>resourcesharing.cn-beijing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2（北京）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <RegionEndpoint>resourcesharing.cn-zhangjiakou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北3（张家口）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-huhehaote</RegionId>\\n <RegionEndpoint>resourcesharing.cn-huhehaote.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北5（呼和浩特）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>resourcesharing.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-heyuan</RegionId>\\n <RegionEndpoint>resourcesharing.cn-heyuan.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南2（河源）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-guangzhou</RegionId>\\n <RegionEndpoint>resourcesharing.cn-guangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南3（广州）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-chengdu</RegionId>\\n <RegionEndpoint>resourcesharing.cn-chengdu.aliyuncs.com</RegionEndpoint>\\n <LocalName>西南1（成都）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-hongkong</RegionId>\\n <RegionEndpoint>resourcesharing.cn-hongkong.aliyuncs.com</RegionEndpoint>\\n <LocalName>中国（香港）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-1</RegionId>\\n <RegionEndpoint>resourcesharing.ap-southeast-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>新加坡</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-northeast-1</RegionId>\\n <RegionEndpoint>resourcesharing.ap-northeast-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>日本（东京）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-northeast-2</RegionId>\\n <RegionEndpoint>resourcesharing.ap-northeast-2.aliyuncs.com</RegionEndpoint>\\n <LocalName>韩国（首尔）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-2</RegionId>\\n <RegionEndpoint>resourcesharing.ap-southeast-2.aliyuncs.com</RegionEndpoint>\\n <LocalName>澳大利亚（悉尼）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-3</RegionId>\\n <RegionEndpoint>resourcesharing.ap-southeast-3.aliyuncs.com</RegionEndpoint>\\n <LocalName>马来西亚（吉隆坡）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-5</RegionId>\\n <RegionEndpoint>resourcesharing.ap-southeast-5.aliyuncs.com</RegionEndpoint>\\n <LocalName>印度尼西亚（雅加达）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-6</RegionId>\\n <RegionEndpoint>resourcesharing.ap-southeast-6.aliyuncs.com</RegionEndpoint>\\n <LocalName>菲律宾（马尼拉）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-7</RegionId>\\n <RegionEndpoint>resourcesharing.ap-southeast-7.aliyuncs.com</RegionEndpoint>\\n <LocalName>泰国（曼谷）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-south-1</RegionId>\\n <RegionEndpoint>resourcesharing.ap-south-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>印度（孟买）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>eu-central-1</RegionId>\\n <RegionEndpoint>resourcesharing.eu-central-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>德国（法兰克福）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>eu-west-1</RegionId>\\n <RegionEndpoint>resourcesharing.eu-west-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>英国（伦敦）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>us-east-1</RegionId>\\n <RegionEndpoint>resourcesharing.us-east-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>美国（弗吉尼亚）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>us-west-1</RegionId>\\n <RegionEndpoint>resourcesharing.us-west-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>美国（硅谷）</LocalName>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckSharingWithResourceDirectoryStatus' => [ + 'summary' => 'Checks the status of resource sharing within a resource directory.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819545D0-C97A-5DB3-BD73-A1B17E9A4BC1', + ], + 'EnableSharingWithRd' => [ + 'description' => 'Indicates whether resource sharing within a resource directory is enabled. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"819545D0-C97A-5DB3-BD73-A1B17E9A4BC1\\",\\n \\"EnableSharingWithRd\\": true\\n}","type":"json"}]', + 'title' => 'CheckSharingWithResourceDirectoryStatus', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Transfers a resource share from one resource group to another.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rs-dz3Ek1iiO***', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => 'The region ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => 'The ID of the destination resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aek2nb47ueqk***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A900114-22D3-5E9D-87A2-48E5EB5BF310', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A900114-22D3-5E9D-87A2-48E5EB5BF310\\"\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to a resource share.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleT3AKMG', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n" + ."\n" + .'Set the value to `ResourceShare`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ResourceShare', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-PqysnzIj****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => 'The region ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n" + ."\n" + .'You can specify up to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'> The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n" + ."\n" + .'> The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The ResourceId is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.RegionId', + 'errorMessage' => 'The RegionId parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'You must specify ResourceType.', + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'You must specify Tags.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\"\\n}","type":"json"}]', + 'title' => 'TagResources', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to resource shares.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'list', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleNPCJ32', + 'FEATUREentconsoleI2HU3Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n" + ."\n" + .'Set the value to `ResourceShare`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ResourceShare', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n" + ."\n" + .'You can specify up to 20 resource shares.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-PqysnzIj****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => 'The region ID of the resource shares.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n" + ."\n" + .'This parameter specifies a filter condition for the query. You can specify up to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'> The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n" + ."\n" + .'> The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The `token` that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8054B059-6B36-53BF-AA45-B8C9A0ED05AB', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-PqysnzIj****', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'The value can be only `ResourceShare`.'."\n", + 'type' => 'string', + 'example' => 'ResourceShare', + ], + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + [ + 'schema' => [ + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIdOrTag', + 'errorMessage' => 'You must specify ResourceId or Tag.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'You must specify ResourceType.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify TagKey.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The TagKey contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"8054B059-6B36-53BF-AA45-B8C9A0ED05AB\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"rs-PqysnzIj****\\",\\n \\"ResourceType\\": \\"ResourceShare\\",\\n \\"TagKey\\": \\"k1\\",\\n \\"TagValue\\": \\"v1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListTagResources', + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from resource shares.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'update', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREentconsoleA4VJ8H', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n" + ."\n" + .'Set the value to `ResourceShare`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ResourceShare', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n" + ."\n" + .'You can specify up to 20 resource shares.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-PqysnzIj****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => 'The region ID of the resource shares.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'You can specify up to 20 tag keys.'."\n" + ."\n" + .'> If you set the `All` parameter to `true`, you do not need to configure this parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'You must specify ResourceType.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The TagKey parameter is invalid.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.TagKeys', + 'errorMessage' => 'The maximum number of TagKeys is exceeded.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The TagKey contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + [ + 'errorCode' => 'MissingParameter.TagKeysOrDeleteAll', + 'errorMessage' => 'You must specify TagKeys or DeleteAll.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + ], + 'ListResourceShareInvitations' => [ + 'summary' => 'Queries the resource sharing invitations that are received.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'ResourceShareIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the resource shares.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rs-ysGRci9z****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceShareInvitationIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the resource sharing invitations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource sharing invitation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-p6eRytrkjVvM****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '30EC8328-1BDE-51D5-BFAB-039508BD91A1', + ], + 'ResourceShareInvitations' => [ + 'description' => 'The information about the resource sharing invitations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resource sharing invitations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Accepted'."\n" + .'* Cancelled'."\n" + .'* Rejected'."\n" + .'* Expired'."\n" + .'* AcceptFailed'."\n", + 'type' => 'string', + 'example' => 'Pending', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-08-18T05:36:45.024Z', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'example' => 'rs-ysGRci9z****', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + 'SenderAccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the inviter.'."\n", + 'type' => 'string', + 'example' => '151266687691****', + ], + 'ReceiverAccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the invitee.'."\n", + 'type' => 'string', + 'example' => '134254031178****', + ], + 'ResourceShareInvitationId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'example' => 'i-p6eRytrkjVvM****', + ], + 'InvitationFailedDetails' => [ + 'description' => 'The information about the failure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the failure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'This parameter is deprecated. The FailureReason parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'Unavailable', + ], + 'StatusMessage' => [ + 'description' => 'This parameter is deprecated. The FailureDescription parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'You cannot access the specified resource at this time.', + ], + 'AssociateType' => [ + 'description' => 'This parameter is deprecated. The OperationType parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'Associate', + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resource.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'FailureReason' => [ + 'description' => 'The failure cause. Valid values:'."\n" + ."\n" + .'* Unavailable: The resource cannot be shared.'."\n" + .'* LimitExceeded: The number of shared resources within the Alibaba Cloud account exceeds the upper limit.'."\n" + .'* ZonalResourceInaccessible: The resource is unavailable in this region.'."\n" + .'* InternalError: An internal error occurred during the check.'."\n" + .'* UnsupportedOperation: You cannot perform this operation.'."\n", + 'type' => 'string', + 'example' => 'Unavailable', + ], + 'FailureDescription' => [ + 'description' => 'The failure description.'."\n", + 'type' => 'string', + 'example' => 'You cannot access the specified resource at this time.', + ], + 'OperationType' => [ + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'* Associate'."\n" + .'* Disassociate'."\n", + 'type' => 'string', + 'example' => 'Associate', + ], + 'ResourceId' => [ + 'description' => 'The ID of the shared resource.'."\n", + 'type' => 'string', + 'example' => 's-7xvh46nx5oqlre0wv***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds', + 'errorMessage' => 'The ResourceShareIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Duplicate', + 'errorMessage' => 'The ResourceShareIds contains duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareIds.Length', + 'errorMessage' => 'The maximum length of ResourceShareIds exceeds 5 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareInvitationIds', + 'errorMessage' => 'The ResourceShareInvitationIds is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareInvitationIds.Duplicate', + 'errorMessage' => 'The ResourceShareInvitationIds duplicate values.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareInvitationIds.Length', + 'errorMessage' => 'The maximum length of ResourceShareInvitationIds exceeds quota limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"30EC8328-1BDE-51D5-BFAB-039508BD91A1\\",\\n \\"ResourceShareInvitations\\": [\\n {\\n \\"Status\\": \\"Pending\\",\\n \\"CreateTime\\": \\"2022-08-18T05:36:45.024Z\\",\\n \\"ResourceShareId\\": \\"rs-ysGRci9z****\\",\\n \\"ResourceShareName\\": \\"example\\",\\n \\"SenderAccountId\\": \\"151266687691****\\",\\n \\"ReceiverAccountId\\": \\"134254031178****\\",\\n \\"ResourceShareInvitationId\\": \\"i-p6eRytrkjVvM****\\",\\n \\"InvitationFailedDetails\\": [\\n {\\n \\"Status\\": \\"None\\",\\n \\"StatusMessage\\": \\"None\\",\\n \\"AssociateType\\": \\"None\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"ResourceType\\": \\"Snapshot\\",\\n \\"FailureReason\\": \\"Unavailable\\",\\n \\"FailureDescription\\": \\"You cannot access the specified resource at this time.\\",\\n \\"OperationType\\": \\"Associate\\",\\n \\"ResourceId\\": \\"s-7xvh46nx5oqlre0wv***\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceShareInvitationsResponse>\\n <ResourceShareInvitations>\\n <Status>Pending</Status>\\n <ResourceShareId>rs-ysGRci9z****</ResourceShareId>\\n <ResourceShareName>example</ResourceShareName>\\n <SenderAccountId>151266687691****</SenderAccountId>\\n <ReceiverAccountId>134254031178****</ReceiverAccountId>\\n <CreateTime>2022-08-18T05:36:45.024Z</CreateTime>\\n <ResourceShareInvitationId>i-p6eRytrkjVvM****</ResourceShareInvitationId>\\n </ResourceShareInvitations>\\n <RequestId>30EC8328-1BDE-51D5-BFAB-039508BD91A1</RequestId>\\n</ListResourceShareInvitationsResponse>","errorExample":""}]', + 'title' => 'ListResourceShareInvitations', + 'description' => '### [](#)'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the resource sharing invitations that are received by the current account in the `cn-hangzhou` region. The response shows that one invitation is received by the current account and is waiting for confirmation.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'AcceptResourceShareInvitation' => [ + 'summary' => 'Accepts a resource sharing invitation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareInvitationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource sharing invitation.'."\n" + ."\n" + .'You can call the [ListResourceShareInvitations](~~450564~~) operation to obtain the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-pMnItMX19fBJ****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '08F18B04-47CB-5C0E-A6D2-37DEF5C2A961', + ], + 'ResourceShareInvitation' => [ + 'description' => 'The information about the resource sharing invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceShareInvitationId' => [ + 'description' => 'The ID of the resource sharing invitation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-pMnItMX19fBJ****', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rs-ysGRci9z****', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + 'SenderAccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the inviter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '151266687691****', + ], + 'ReceiverAccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the invitee.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '134254031178****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-09-02T06:43:12.353Z', + ], + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Accepted'."\n" + .'* Cancelled'."\n" + .'* Rejected'."\n" + .'* Expired'."\n" + .'* AcceptFailed'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AcceptFailed', + ], + 'AcceptInvitationFailedDetails' => [ + 'description' => 'The information about the failure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the failure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'This parameter is deprecated. The FailureReason parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'Unavailable', + ], + 'StatusMessage' => [ + 'description' => 'This parameter is deprecated. The FailureDescription parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'You cannot access the specified resource at this time.', + ], + 'AssociateType' => [ + 'description' => 'This parameter is deprecated. The OperationType parameter is used instead.'."\n", + 'type' => 'string', + 'example' => 'Associate', + ], + 'ResourceArn' => [ + 'type' => 'string', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resource.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'FailureReason' => [ + 'description' => 'The failure cause. Valid values:'."\n" + ."\n" + .'* Unavailable: The resource cannot be shared.'."\n" + .'* LimitExceeded: The number of shared resources within the Alibaba Cloud account exceeds the upper limit.'."\n" + .'* ZonalResourceInaccessible: The resource is unavailable in this region.'."\n" + .'* InternalError: An internal error occurred during the check.'."\n", + 'type' => 'string', + 'example' => 'Unavailable', + ], + 'FailureDescription' => [ + 'description' => 'The failure description.'."\n", + 'type' => 'string', + 'example' => 'You cannot access the specified resource at this time.', + ], + 'OperationType' => [ + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'* Associate'."\n", + 'type' => 'string', + 'example' => 'Associate', + ], + 'ResourceId' => [ + 'description' => 'The ID of the shared resource.'."\n", + 'type' => 'string', + 'example' => 's-7xvh46nx5oqlre0wv***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceShareInvitationId', + 'errorMessage' => 'The ResourceShareInvitationId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceShareInvitationId', + 'errorMessage' => 'You must specify ResourceShareInvitationId.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvitationStatus.Expired', + 'errorMessage' => 'The resource share invitation status is expired.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceShareInvitation', + 'errorMessage' => 'The resource share invitation does not exist in the current account.', + ], + [ + 'errorCode' => 'InvitationStatus.AlreadyRejected', + 'errorMessage' => 'The resource share invitation status is rejected.', + ], + [ + 'errorCode' => 'InvitationStatus.AlreadyAccepted', + 'errorMessage' => 'The resource share invitation status is alredy accepted.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"08F18B04-47CB-5C0E-A6D2-37DEF5C2A961\\",\\n \\"ResourceShareInvitation\\": {\\n \\"ResourceShareInvitationId\\": \\"i-pMnItMX19fBJ****\\",\\n \\"ResourceShareId\\": \\"rs-ysGRci9z****\\",\\n \\"ResourceShareName\\": \\"example\\",\\n \\"SenderAccountId\\": \\"151266687691****\\",\\n \\"ReceiverAccountId\\": \\"134254031178****\\",\\n \\"CreateTime\\": \\"2022-09-02T06:43:12.353Z\\",\\n \\"Status\\": \\"AcceptFailed\\",\\n \\"AcceptInvitationFailedDetails\\": [\\n {\\n \\"Status\\": \\"None\\",\\n \\"StatusMessage\\": \\"None\\",\\n \\"AssociateType\\": \\"None\\",\\n \\"ResourceArn\\": \\"acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****\\",\\n \\"ResourceType\\": \\"Snapshot\\",\\n \\"FailureReason\\": \\"Unavailable\\",\\n \\"FailureDescription\\": \\"You cannot access the specified resource at this time.\\",\\n \\"OperationType\\": \\"Associate\\",\\n \\"ResourceId\\": \\"s-7xvh46nx5oqlre0wv***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<AcceptResourceShareInvitationResponse>\\n <RequestId>08F18B04-47CB-5C0E-A6D2-37DEF5C2A961</RequestId>\\n <ResourceShareInvitation>\\n <ResourceShareId>rs-ysGRci9z****</ResourceShareId>\\n <ResourceShareName>example</ResourceShareName>\\n <Status>Accepted</Status>\\n <SenderAccountId>151266687691****</SenderAccountId>\\n <ReceiverAccountId>134254031178****</ReceiverAccountId>\\n <CreateTime>2022-09-02T06:43:12.353Z</CreateTime>\\n <ResourceShareInvitationId>i-pMnItMX19fBJ****</ResourceShareInvitationId>\\n </ResourceShareInvitation>\\n</AcceptResourceShareInvitationResponse>","errorExample":""}]', + 'title' => 'AcceptResourceShareInvitation', + 'description' => '### [](#)'."\n" + ."\n" + .'* A principal needs to accept or reject a resource sharing invitation only if the principal is not the management account or a member of a resource directory. If you share resources with an object in a resource directory, the system automatically accepts the resource sharing invitation for the object.'."\n" + .'* A resource sharing invitation is valid for seven days. A principal must accept or reject the invitation within the validity period.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to accept the resource sharing invitation whose ID is `i-pMnItMX19fBJ****` in the `cn-hangzhou` region.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'RejectResourceShareInvitation' => [ + 'summary' => 'Rejects a resource sharing invitation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareInvitationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource sharing invitation.'."\n" + ."\n" + .'You can call the [ListResourceShareInvitations](~~450564~~) operation to obtain the ID of a resource sharing invitation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-yyTWbkjHArYh****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E446D6DE-BFC8-5F37-A494-33D7B118147D', + ], + 'ResourceShareInvitation' => [ + 'description' => 'The information of the resource sharing invitation.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceShareInvitationId' => [ + 'description' => 'The ID of the invitation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-yyTWbkjHArYh****', + ], + 'ResourceShareId' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rs-JoA1Ayjm****', + ], + 'ResourceShareName' => [ + 'description' => 'The name of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + 'SenderAccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the inviter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '151266687691****', + ], + 'ReceiverAccountId' => [ + 'description' => 'The Alibaba Cloud account ID of the invitee.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '134254031178****', + ], + 'CreateTime' => [ + 'description' => 'The time when the invitation was created. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-09-02T07:07:30.809Z', + ], + 'Status' => [ + 'description' => 'The status of the invitation. Valid values:'."\n" + ."\n" + .'* Pending: The invitation is waiting for confirmation.'."\n" + .'* Accepted: The invitation is accepted.'."\n" + .'* Cancelled: The invitation is canceled.'."\n" + .'* Rejected: The invitation is rejected.'."\n" + .'* Expired: The invitation has expired.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Rejected', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceShareInvitationId', + 'errorMessage' => 'The ResourceShareInvitationId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceShareInvitationId', + 'errorMessage' => 'You must specify ResourceShareInvitationId.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvitationStatus.Expired', + 'errorMessage' => 'The resource share invitation status is expired.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceShareInvitation', + 'errorMessage' => 'The resource share invitation does not exist in the current account.', + ], + [ + 'errorCode' => 'InvitationStatus.AlreadyRejected', + 'errorMessage' => 'The resource share invitation status is rejected.', + ], + [ + 'errorCode' => 'InvitationStatus.AlreadyAccepted', + 'errorMessage' => 'The resource share invitation status is alredy accepted.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E446D6DE-BFC8-5F37-A494-33D7B118147D\\",\\n \\"ResourceShareInvitation\\": {\\n \\"ResourceShareInvitationId\\": \\"i-yyTWbkjHArYh****\\",\\n \\"ResourceShareId\\": \\"rs-JoA1Ayjm****\\",\\n \\"ResourceShareName\\": \\"example\\",\\n \\"SenderAccountId\\": \\"151266687691****\\",\\n \\"ReceiverAccountId\\": \\"134254031178****\\",\\n \\"CreateTime\\": \\"2022-09-02T07:07:30.809Z\\",\\n \\"Status\\": \\"Rejected\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RejectResourceShareInvitationResponse>\\n <RequestId>E446D6DE-BFC8-5F37-A494-33D7B118147D</RequestId>\\n <ResourceShareInvitation>\\n <ResourceShareId>rs-JoA1Ayjm****</ResourceShareId>\\n <ResourceShareName>example</ResourceShareName>\\n <Status>Rejected</Status>\\n <SenderAccountId>151266687691****</SenderAccountId>\\n <ReceiverAccountId>134254031178****</ReceiverAccountId>\\n <CreateTime>2022-09-02T07:07:30.809Z</CreateTime>\\n <ResourceShareInvitationId>i-yyTWbkjHArYh****</ResourceShareInvitationId>\\n </ResourceShareInvitation>\\n</RejectResourceShareInvitationResponse>","errorExample":""}]', + 'title' => 'RejectResourceShareInvitation', + 'description' => 'This topic provides an example on how to call the API operation to reject the resource sharing invitation `i-yyTWbkjHArYh****` in the `cn-hangzhou` region.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'AssociateResourceSharePermission' => [ + 'summary' => 'Associates permissions with a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-6GRmdD3X****', + ], + ], + [ + 'name' => 'PermissionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + ], + [ + 'name' => 'Replace', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use the specified permission to replace an existing permission. Valid values:'."\n" + ."\n" + .'* false: does not use the specified permission to replace an existing permission. This is the default value. If you set the value to false for a resource share that does not have associated permissions, the system associates the specified permission with the resource share. In a resource share, one resource type can have only one permission. If you set the value to false for a resource share that already has a permission for the resource type indicated by the specified permission, the system reports an error. This prevents you from replacing the existing permission by mistake.'."\n" + .'* true: uses the specified permission to replace an existing permission of the same resource type.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '111FB84A-60A9-403E-9067-E55D7EE95BD1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'MissingParameter.PermissionName', + 'errorMessage' => 'You must specify PermissionName.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Permission', + 'errorMessage' => 'The resource share permission does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"111FB84A-60A9-403E-9067-E55D7EE95BD1\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateResourceSharePermissionResponse>\\n <RequestId>2C3FA051-61DC-4F3E-81E9-E4830524DF4B</RequestId>\\n</AssociateResourceSharePermissionResponse>","errorExample":""}]', + 'title' => 'AssociateResourceSharePermission', + 'description' => 'This topic provides an example on how to call the API operation to associate the `AliyunRSDefaultPermissionVSwitch` permission with the `rs-6GRmdD3X****` resource share in the `cn-hangzhou` region.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'DisassociateResourceSharePermission' => [ + 'summary' => 'Disassociates a permission from a resource share. You can disassociate a permission from a resource share only if the resource share does not contain resources of the type indicated by the permission.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-6GRmdD3X****', + ], + ], + [ + 'name' => 'PermissionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission. For more information, see [Permission library](~~465474~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '111FB84A-60A9-403E-9067-E55D7EE95BD1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'MissingParameter.PermissionName', + 'errorMessage' => 'You must specify PermissionName.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Permission', + 'errorMessage' => 'The resource share permission does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'DisassociateConflict.Permission', + 'errorMessage' => 'Existing associated resource when disassociating permission with resource share.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"111FB84A-60A9-403E-9067-E55D7EE95BD1\\"\\n}","errorExample":""},{"type":"xml","example":"<DisassociateResourceSharePermissionResponse>\\n <RequestId>111FB84A-60A9-403E-9067-E55D7EE95BD1</RequestId>\\n</DisassociateResourceSharePermissionResponse>","errorExample":""}]', + 'title' => 'DisassociateResourceSharePermission', + 'description' => 'This topic provides an example on how to call the API operation to disassociate the `AliyunRSDefaultPermissionVSwitch` permission from the `rs-6GRmdD3X****` resource share in the `cn-hangzhou` region.', + ], + 'ListResourceSharePermissions' => [ + 'summary' => 'Queries the permissions that are associated with a resource share.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ResourceShareId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource share.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rs-6GRmdD3X****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + [ + 'name' => 'ResourceOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the resource share. Valid values:'."\n" + ."\n" + .'* Self: the current account'."\n" + .'* OtherAccounts: an account other than the current account'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Self', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The `token` that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA', + ], + 'Permissions' => [ + 'description' => 'The information about the permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the permissions.', + 'type' => 'object', + 'properties' => [ + 'PermissionName' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + 'PermissionVersion' => [ + 'description' => 'The version of the permission.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'DefaultVersion' => [ + 'description' => 'Indicates whether the version is the default version. Valid values:'."\n" + ."\n" + .'* false: The version is not the default version.'."\n" + .'* true: The version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'UpdateTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'DefaultPermission' => [ + 'description' => 'Indicates whether the permission is the default permission. Valid values:'."\n" + ."\n" + .'* false: The permission is not the default permission.'."\n" + .'* true: The permission is the default permission.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceShareId', + 'errorMessage' => 'You must specify ResourceShareId.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceShareId', + 'errorMessage' => 'The ResourceShareId is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceOwner', + 'errorMessage' => 'The ResourceOwner is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceOwner', + 'errorMessage' => 'You must specify ResourceOwner.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceShare', + 'errorMessage' => 'The resource share does not exist in the current account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionName\\": \\"AliyunRSDefaultPermissionVSwitch\\",\\n \\"PermissionVersion\\": \\"v1\\",\\n \\"DefaultVersion\\": true,\\n \\"CreateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"UpdateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"ResourceType\\": \\"VSwitch\\",\\n \\"DefaultPermission\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceSharePermissionsResponse>\\n <NextToken>TGlzdFJlc291cm****</NextToken>\\n <RequestId>2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA</RequestId>\\n <Permissions>\\n <PermissionName>AliyunRSDefaultPermissionVSwitch</PermissionName>\\n <PermissionVersion>v1</PermissionVersion>\\n <DefaultVersion>true</DefaultVersion>\\n <CreateTime>2020-12-07T07:39:01.818Z</CreateTime>\\n <UpdateTime>2020-12-07T07:39:01.818Z</UpdateTime>\\n <ResourceType>VSwitch</ResourceType>\\n <DefaultPermission>true</DefaultPermission>\\n </Permissions>\\n</ListResourceSharePermissionsResponse>","errorExample":""}]', + 'title' => 'ListResourceSharePermissions', + 'description' => 'This topic provides an example on how to call the API operation to query the permissions that are associated with the resource share created by using the current Alibaba Cloud account in the `cn-hangzhou` region.', + ], + 'GetPermission' => [ + 'summary' => 'Queries the information about a permission.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PermissionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + ], + [ + 'name' => 'PermissionVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the permission.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA', + ], + 'Permission' => [ + 'description' => 'The information about the permission.'."\n", + 'type' => 'object', + 'properties' => [ + 'PermissionName' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + 'PermissionVersion' => [ + 'description' => 'The version of the permission.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Permission' => [ + 'description' => 'The document of the policy related to the permission.'."\n", + 'type' => 'string', + 'example' => '{"Effect":"Allow","Action":["vpc:DescribeVSwitches","vpc:DescribeVSwitchAttributes"]}', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'DefaultVersion' => [ + 'description' => 'Indicates whether the version is the default version. Valid values:'."\n" + ."\n" + .'* false: The version is not the default version.'."\n" + .'* true: The version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'UpdateTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'DefaultPermission' => [ + 'description' => 'Indicates whether the permission is the default permission. Valid values:'."\n" + ."\n" + .'* false: The permission is not the default permission.'."\n" + .'* true: The permission is the default permission.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PermissionVersion', + 'errorMessage' => 'The PermissionVersion is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.PermissionName', + 'errorMessage' => 'You must specify PermissionName.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExists.Permission', + 'errorMessage' => 'The resource share permission does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA\\",\\n \\"Permission\\": {\\n \\"PermissionName\\": \\"AliyunRSDefaultPermissionVSwitch\\",\\n \\"PermissionVersion\\": \\"v1\\",\\n \\"Permission\\": \\"{\\\\\\"Effect\\\\\\":\\\\\\"Allow\\\\\\",\\\\\\"Action\\\\\\":[\\\\\\"vpc:DescribeVSwitches\\\\\\",\\\\\\"vpc:DescribeVSwitchAttributes\\\\\\"]}\\",\\n \\"ResourceType\\": \\"VSwitch\\",\\n \\"DefaultVersion\\": true,\\n \\"CreateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"UpdateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"DefaultPermission\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPermissionResponse>\\n <RequestId>2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA</RequestId>\\n <Permission>\\n <PermissionName>AliyunRSDefaultPermissionVSwitch</PermissionName>\\n <PermissionVersion>v1</PermissionVersion>\\n <Permission>{\\\\\\"Effect\\\\\\":\\\\\\"Allow\\\\\\",\\\\\\"Action\\\\\\":[\\\\\\"vpc:DescribeVSwitches\\\\\\",\\\\\\"vpc:DescribeVSwitchAttributes\\\\\\"]}</Permission>\\n <ResourceType>VSwitch</ResourceType>\\n <DefaultVersion>true</DefaultVersion>\\n <CreateTime>2020-12-07T07:39:01.818Z</CreateTime>\\n <UpdateTime>2020-12-07T07:39:01.818Z</UpdateTime>\\n <DefaultPermission>true</DefaultPermission>\\n </Permission>\\n</GetPermissionResponse>","errorExample":""}]', + 'title' => 'GetPermission', + 'description' => 'This topic provides an example on how to call the API operation to query the information about the `AliyunRSDefaultPermissionVSwitch` permission whose version is `v1` in the `cn-hangzhou` region.', + ], + 'ListPermissionVersions' => [ + 'summary' => 'Queries the versions of a permission.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PermissionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04677DCA-7C33-464B-8811-1B1DA3C3D197', + ], + 'Permissions' => [ + 'description' => 'The information about the permission.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the permission.', + 'type' => 'object', + 'properties' => [ + 'PermissionName' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + 'PermissionVersion' => [ + 'description' => 'The version of the permission.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'DefaultVersion' => [ + 'description' => 'Indicates whether the version is the default version. Valid values:'."\n" + ."\n" + .'* false: The version is not the default version.'."\n" + .'* true: The version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'UpdateTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'DefaultPermission' => [ + 'description' => 'Indicates whether the permission is the default permission. Valid values:'."\n" + ."\n" + .'* false: The permission is not the default permission.'."\n" + .'* true: The permission is the default permission.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.PermissionName', + 'errorMessage' => 'You must specify PermissionName.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"04677DCA-7C33-464B-8811-1B1DA3C3D197\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionName\\": \\"AliyunRSDefaultPermissionVSwitch\\",\\n \\"PermissionVersion\\": \\"v1\\",\\n \\"DefaultVersion\\": true,\\n \\"CreateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"UpdateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"ResourceType\\": \\"VSwitch\\",\\n \\"DefaultPermission\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPermissionVersionsResponse>\\n <NextToken>TGlzdFJlc291cm****</NextToken>\\n <RequestId>04677DCA-7C33-464B-8811-1B1DA3C3D197</RequestId>\\n <Permissions>\\n <PermissionName>AliyunRSDefaultPermissionVSwitch</PermissionName>\\n <PermissionVersion>v1</PermissionVersion>\\n <DefaultVersion>true</DefaultVersion>\\n <CreateTime>2020-12-07T07:39:01.818Z</CreateTime>\\n <UpdateTime>2020-12-07T07:39:01.818Z</UpdateTime>\\n <ResourceType>VSwitch</ResourceType>\\n <DefaultPermission>true</DefaultPermission>\\n </Permissions>\\n</ListPermissionVersionsResponse>","errorExample":""}]', + 'title' => 'ListPermissionVersions', + 'description' => 'This topic provides an example on how to call the API operation to query the versions of the `AliyunRSDefaultPermissionVSwitch` permission in the `cn-hangzhou` region.', + ], + 'ListPermissions' => [ + 'summary' => 'Queries the information about the default permission.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitch', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return for a single request.'."\n" + ."\n" + .'Valid values: 1 to 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The `token` that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to initiate the next request. If the response of the current request is truncated, you can use the token to initiate another request and obtain the remaining records.'."\n", + 'type' => 'string', + 'example' => 'TGlzdFJlc291cm****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04677DCA-7C33-464B-8811-1B1DA3C3D197', + ], + 'Permissions' => [ + 'description' => 'The information about the permission.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the permission.', + 'type' => 'object', + 'properties' => [ + 'PermissionName' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'example' => 'AliyunRSDefaultPermissionVSwitch', + ], + 'PermissionVersion' => [ + 'description' => 'The version of the permission.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'DefaultVersion' => [ + 'description' => 'Indicates whether the version is the default version. Valid values:'."\n" + ."\n" + .'* false: The version is not the default version.'."\n" + .'* true: The version is the default version.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'UpdateTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2020-12-07T07:39:01.818Z', + ], + 'ResourceType' => [ + 'description' => 'The type of the shared resources.'."\n" + ."\n" + .'For more information about the types of resources that can be shared, see [Services that work with Resource Sharing](~~450526~~).'."\n", + 'type' => 'string', + 'example' => 'VSwitch', + ], + 'DefaultPermission' => [ + 'description' => 'Indicates whether the permission is the default permission. Valid values:'."\n" + ."\n" + .'* false: The permission is not the default permission.'."\n" + .'* true: The permission is the default permission.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxResults', + 'errorMessage' => 'The MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken.Length', + 'errorMessage' => 'The maximum length of NextToken exceeds 256 characters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cm****\\",\\n \\"RequestId\\": \\"04677DCA-7C33-464B-8811-1B1DA3C3D197\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionName\\": \\"AliyunRSDefaultPermissionVSwitch\\",\\n \\"PermissionVersion\\": \\"v1\\",\\n \\"DefaultVersion\\": true,\\n \\"CreateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"UpdateTime\\": \\"2020-12-07T07:39:01.818Z\\",\\n \\"ResourceType\\": \\"VSwitch\\",\\n \\"DefaultPermission\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPermissionsResponse>\\n <NextToken>TGlzdFJlc291cm****</NextToken>\\n <RequestId>04677DCA-7C33-464B-8811-1B1DA3C3D197</RequestId>\\n <Permissions>\\n <PermissionName>AliyunRSDefaultPermissionVSwitch</PermissionName>\\n <PermissionVersion>v1</PermissionVersion>\\n <DefaultVersion>true</DefaultVersion>\\n <CreateTime>2020-12-07T07:39:01.818Z</CreateTime>\\n <UpdateTime>2020-12-07T07:39:01.818Z</UpdateTime>\\n <ResourceType>VSwitch</ResourceType>\\n <DefaultPermission>true</DefaultPermission>\\n </Permissions>\\n</ListPermissionsResponse>","errorExample":""}]', + 'title' => 'ListPermissions', + 'description' => 'This topic provides an example on how to call the API operation to query the information about the default permission for the `VSwitch` resource type in the `cn-hangzhou` region.', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'resourcesharing.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'resourcesharing.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'resourcesharing.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'resourcesharing.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'resourcesharing.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'resourcesharing.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'resourcesharing.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'resourcesharing.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'resourcesharing.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'resourcesharing.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'resourcesharing.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'resourcesharing.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'resourcesharing.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'resourcesharing.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'resourcesharing.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'resourcesharing.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'resourcesharing.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'resourcesharing.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'resourcesharing.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'resourcesharing.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'resourcesharing.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'resourcesharing.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'resourcesharing.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'resourcesharing.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'resourcesharing.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'resourcesharing.cn-heyuan-acdr-1.aliyuncs.com', + ], + ], +]; |