CreateResourceShare - Resource Management - Alibaba Cloud Documentation Center

Creates a resource share.

Operation 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.

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
resourcesharing:CreateResourceShare	create	All Resources ``	resourcesharing:RequestedAllowExternalTargets resourcesharing:Target resourcesharing:RequestedResourceType	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceShareName	string	Yes	The name of the resource share. The name must be 1 to 50 characters in length. The name can contain letters, digits, periods (.), underscores (_), and hyphens (-).	test
Resources	array<object>	No	The information about the shared resources.
	object	No	The shared resource.
ResourceId	string	No	The ID of a shared resource. Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time. Note `Resources.N.ResourceId` and `Resources.N.ResourceType` must be used in pairs.	vsw-bp183p93qs667muql****
ResourceType	string	No	The type of a shared resource. Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time. For more information about the types of resources that can be shared, see Services that work with Resource Sharing. Note `Resources.N.ResourceId` and `Resources.N.ResourceType` must be used in pairs.	VSwitch
Targets	array	No	The information about the principals.
	string	No	The information about a principal. If the value of `AllowExternalTargets` is `false`, you can set this parameter to the ID of a resource directory, folder, or member. 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. For more information, see Resource sharing modes, View the ID of a resource directory, View the ID of a folder, or View the ID of a member. Valid values of N: 1 to 5. This indicates that a maximum of five principals can be specified at a time.	172050525300****
PermissionNames	array	No	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.
	string	No	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.	AliyunRSDefaultPermissionVSwitch
AllowExternalTargets	boolean	No	Specifies whether resources in the resource share can be shared with accounts outside the resource directory. Valid values: false (default): Resources in the resource share can be shared only with accounts in the resource directory. true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.	false
ResourceGroupId	string	No	The resource group ID.	rg-aekz5nlvlak****
TargetProperties	array<object>	No	The properties of the principal. Note This parameter is available only when you specify an Alibaba Cloud service as a principal.
	object	No
Property	string	No	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`: timeRange: a specific time range day: all day Note `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.	{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }
TargetId	string	No	The ID of the principal. Note `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.	172050525300****
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tags.
Key	string	No	The tag key. Note 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://`.	k1
Value	string	No	The tag value. Note The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.	v1

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	2C3FA051-61DC-4F3E-81E9-E4830524DF4B
ResourceShare	object	The information about the resource share.
AllowExternalTargets	boolean	Indicates whether resources in the resource share can be shared with accounts outside the resource directory. Valid values: false: Resources in the resource share can be shared only with accounts in the resource directory. true: Resources in the resource share can be shared with both accounts in the resource directory and accounts outside the resource directory.	false
CreateTime	string	The time when the resource share was created.	2020-12-03T08:02:22.413Z
ResourceShareId	string	The ID of the resource share.	rs-qSkW1HBY****
ResourceShareName	string	The name of the resource share.	test
ResourceShareOwner	string	The owner of the resource share.	151266687691****
ResourceShareStatus	string	The status of the resource share. Valid values: Active: The resource share is enabled. Pending: The resource share is associated with one or more resource sharing invitations that are waiting for confirmation. Deleting: The resource share is being deleted. Deleted: The resource share is deleted. Note 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.	Active
UpdateTime	string	The time when the resource share was updated.	2020-12-03T08:02:22.413Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "2C3FA051-61DC-4F3E-81E9-E4830524DF4B",
  "ResourceShare": {
    "AllowExternalTargets": false,
    "CreateTime": "2020-12-03T08:02:22.413Z",
    "ResourceShareId": "rs-qSkW1HBY****",
    "ResourceShareName": "test",
    "ResourceShareOwner": "151266687691****",
    "ResourceShareStatus": "Active",
    "UpdateTime": "2020-12-03T08:02:22.413Z"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ResourceShareName	The ResourceShareName is invalid.	The ResourceShareName parameter is invalid.
400	InvalidParameter.ResourceShareName.Length	The maximum length of ResourceShareName exceeds 50 characters.	The length of ResourceShareName cannot exceed 50 characters.
400	InvalidParameter.Resources	The Resources is invalid.	The specified shared resource is invalid.
400	InvalidParameter.Resources.Duplicate	The Resources contains duplicate values.	The specified Resources parameter contains duplicate values.
400	InvalidParameter.Resources.Length	The maximum number of Resources exceeds 5.	The number of specified shared resources cannot exceed 5.
400	InvalidParameter.Targets	The Targets is invalid.	The specified Targets parameter is invalid.
400	InvalidParameter.Targets.Duplicate	The Targets contains duplicate values.	The specified Targets parameter contains duplicate values.
400	InvalidParameter.Targets.Length	The maximum number of Targets exceeds 5.	The number of Targets values cannot exceed 5.
400	InvalidTarget	The shared target does not exist in the resource directory.	The specified Targets value is not a member in the resource directory.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	MissingParameter.ResourceShareName	You must specify ResourceShareName.	The ResourceShareName parameter is missing.
400	InvalidParameter.ResourceType	The ResourceType is invalid.	The specified ResourceType parameter is invalid.
400	InvalidParameter.PermissionNames.Duplicate	The PermissionNames duplicate values.	Duplicate values are specified for the PermissionNames parameter.
400	InvalidParameter.PermissionNames.Length	The maximum length of PermissionNames exceeds quota limit.	The length of the value specified for the PermissionNames parameter exceeds the limit.
400	InvalidParameter.TargetProperties	The TargetProperties is invalid.	The TargetProperties is invalid.
400	InvalidParameter.TargetProperties.Duplicate	The TargetProperties contains duplicate values.	TargetProperties contains duplicate parameters.
400	InvalidParameter.TargetProperties.Length	The TargetProperties beyond the length limit.	The TargetProperties beyond the length limit.
404	EntityNotExists.Permission	The resource share permission does not exist.	You do not have the required permissions.
409	NotEnableSharingWithResourceDirectory	You have not enabled sharing with your Resource Directory.	You have not enabled sharing with Resource Directory.
409	AccountNotInResourceDirectory	The account is not a master or a member of a resource directory.	The specified Targets value is not a member in the resource directory.
409	QuotaExceeded.ResourceShare.Count	The maximum number of ResourceShare exceeds the limit.	The maximum number of ResourceShare exceeds the limit.
409	EntityAlreadyExists.ResourceShare	The specified resource share ID already exists.	The specified resource share ID already exists.
409	QuotaExceeded.SharedResource.Count	The maximum number of shared resources per account exceeds the limit.	The maximum number of Resources values per account is exceeded.
409	ShareWithYourself	You cannot share resources with yourself.	You cannot share resources with yourself.
409	NotManagementAccount	Only the management account of the service is allowed to share such resources.	Only the management account of the resource directory can be used to share the current type of resource. If you still want to use the current account, contact the owner of the management account to configure the current account as a delegated administrator account of the trusted service to which the resource belongs.
409	QuotaExceeded.PendingInvitations	The maximum number of pending invitations exceeds the limit.	The number of invitations exceeds the upper limit.
409	InvalidTarget.LegalEntityMismatch	The target account does not have the same legal entity as the resource owner account.	The enterprise name of the principal is inconsistent with that of the resource owner.
409	ExternalTargetsNotAllowed.ResourceType	The resource share includes resource types that cannot be shared with accounts outside the resource directory.	The resource share contains resources that do not support this operation.
409	InvalidTarget.SiteMismatch	Cross-site resource sharing is not supported.	The principal and resource owner are registered at different sites.
409	NotSupport.Service.ExistInOtherResourceShare	The resource type has been shared to the target service through other resourceShare. Please share it in the same resourceShare.	-
409	NotSupport.Service.AssociateConflict	The same resource cannot be shared repeatedly to the target service.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-23	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-01-03	The Error code has changed	View Change Details
2023-04-07	The Error code has changed	View Change Details
2023-04-07	The Error code has changed	View Change Details
2023-04-03	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-03-02	API Description Update. The Error code has changed. The request parameters of the API has changed	View Change Details