调用AssociateResourceShare关联共享资源或资源使用者_资源管理(Resource Management)-阿里云帮助中心

为共享单元关联共享资源或资源使用者。

接口说明

本文将提供一个示例，在cn-hangzhou地域的共享单元rs-6GRmdD3X****中，添加共享资源 VPC 交换机vsw-bp183p93qs667muql****，将其共享给资源目录内的成员172050525300****。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

resourcesharing:AssociateResourceShare

update

*全部资源

*

resourcesharing:Target
resourcesharing:RequestedResourceType
resourcesharing:ResourceArn

无

请求参数

名称	类型	必填	描述	示例值
ResourceShareId	string	是	共享单元 ID。	rs-6GRmdD3X****
Resources	array<object>	否	资源列表。
	object	否	资源列表。
ResourceType	string	否	共享资源类型。 N 的取值范围：1~5，即每次最多添加 5 个共享资源。支持共享的资源类型，请参见支持资源共享的云服务。说明 `Resources.N.ResourceId`与`Resources.N.ResourceType`成对出现，需要同时设置。	VSwitch
ResourceId	string	否	共享资源 ID。 N 的取值范围：1~5，即每次最多添加 5 个共享资源。说明 Resources.N.ResourceId 与 Resources.N.ResourceType 成对出现，需要同时设置。	vsw-bp183p93qs667muql****
Targets	array	否	资源使用者。	172050525300****
	string	否	资源使用者。取值：当`AllowExternalTargets`为`false`时，即仅允许资源目录内共享时，资源使用者可以为资源目录 ID、资源夹 ID 或成员 ID。当`AllowExternalTargets`为`true`时，即允许共享给任意账号时，资源使用者可以为阿里云账号 ID、资源目录 ID、资源夹 ID、成员 ID 或阿里云服务。更多信息，请参见资源共享方式、查看资源目录 ID、查看资源夹 ID或查看成员 ID。 N 的取值范围：1~5，即每次最多添加 5 个资源使用者。	172050525300****
ResourceArns	array	否
	string	否
PermissionNames	array	否	共享权限名称。为空时，系统自动绑定资源类型关联的默认权限。具体信息，请参见权限库。
	string	否	共享权限名称。为空时，系统自动绑定资源类型关联的默认权限。具体信息，请参见权限库。	AliyunRSDefaultPermissionVSwitch
TargetProperties	array<object>	否	资源使用者属性。说明仅当资源使用者为阿里云服务时可以设置该参数。
	object	否	资源使用者属性。说明仅当资源使用者为阿里云服务时可以设置该参数。
TargetId	string	否	资源使用者 ID。说明 `TargetProperties.N.TargetId`与`TargetProperties.N.Property`成对出现，需要同时设置。	172050525300****
Property	string	否	资源使用者属性参数。例如：您可以设置资源共享的时间段。`timeRangeType`取值： timeRange：指定时间段。 day：全天。说明 `TargetProperties.N.TargetId`与`TargetProperties.N.Property`成对出现，需要同时设置。	{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	111FB84A-60A9-403E-9067-E55D7EE95BD1
ResourceShareAssociations	array<object>	共享单元关联的共享资源或资源使用者信息。
	object	共享单元关联的共享资源或资源使用者信息。
UpdateTime	string	更新关联的时间。存在以下两种情况：当关联类型`AssociationType`为资源`Resource`时，该参数为更新资源的时间。当关联类型`AssociationType`为资源使用者`Target`时，该参数为更新资源使用者的时间。	2020-12-04T09:40:41.246Z
ResourceArn	string
ResourceShareName	string	共享单元名称。	test
CreateTime	string	关联的时间。存在以下两种情况：当关联类型`AssociationType`为资源`Resource`时，该参数为添加资源的时间。当关联类型`AssociationType`为资源使用者`Target`时，该参数为添加资源使用者的时间。	2020-12-04T09:40:41.246Z
EntityType	string	关联实体类型。取值：当关联实体为资源时，该参数为资源类型。更多信息，请参见支持资源共享的云服务。当关联实体为资源使用者时，该参数为`Account`。	VSwitch
ResourceShareId	string	共享单元 ID。	rs-6GRmdD3X****
AssociationStatusMessage	string	关联失败的原因。	The reason for the association failure.
AssociationType	string	关联类型。取值： Resource：资源。 Target：资源使用者。	Resource
AssociationStatus	string	关联状态。取值： Associating：关联中。 Associated：已关联。 Failed：关联失败。 Disassociating：分离中。 Disassociated：已分离。说明 `Failed`和`Disassociated`状态的记录，会在 48~96 小时内被系统自动删除。	Associating
TargetProperty	string	资源使用者属性。例如：资源共享的时间段。说明仅当资源使用者为阿里云服务时返回设置该参数。	{ "plan":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }
EntityId	string	关联实体 ID。取值：当关联类型`AssociationType`为资源`Resource`时，该参数为资源 ID。当关联类型`AssociationType`为资源使用者`Target` 时，该参数为资源使用者 ID。	vsw-bp183p93qs667muql****

示例

正常返回示例

JSON格式

{
  "RequestId": "111FB84A-60A9-403E-9067-E55D7EE95BD1",
  "ResourceShareAssociations": [
    {
      "UpdateTime": "2020-12-04T09:40:41.246Z",
      "ResourceArn": "",
      "ResourceShareName": "test",
      "CreateTime": "2020-12-04T09:40:41.246Z",
      "EntityType": "VSwitch",
      "ResourceShareId": "rs-6GRmdD3X****",
      "AssociationStatusMessage": "The reason for the association failure.",
      "AssociationType": "Resource",
      "AssociationStatus": "Associating",
      "TargetProperty": "{\n    \"plan\":{\n        \"timeRangeType\":\"timeRange\",\n        \"beginAtTime\":\"00:00\",\n        \"timezone\":\"UTC+8\",\n        \"endAtTime\":\"19:59\"\n    }\n}",
      "EntityId": "vsw-bp183p93qs667muql****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter.ResourceShareId	You must specify ResourceShareId.	ResourceShareId参数缺失。
400	InvalidParameter.ResourceShareId	The ResourceShareId is invalid.	ResourceShareId参数错误。
400	InvalidParameter.Resources	The Resources is invalid.	选定的共享资源无效。
400	InvalidParameter.Resources.Duplicate	The Resources contains duplicate values.	选定的共享资源有重复项。
400	InvalidParameter.Resources.Length	The maximum number of Resources exceeds 5.	选定的共享资源数量超限（最大5个）。
400	InvalidParameter.Targets	The Targets is invalid.	资源使用者的参数不符合规则。
400	InvalidParameter.Targets.Duplicate	The Targets contains duplicate values.	资源使用者有重复项。
400	InvalidParameter.Targets.Length	The maximum number of Targets exceeds 5.	资源使用者数量超限（最大5个）。
400	InvalidTarget	The shared target does not exist in the resource directory.	资源使用者不在资源目录内。
400	ResourceAndTargetBothEmpty	Either a resource or a shared target must be specified.	必须指定一个资源或一个资源使用者。
400	InvalidParameter	The specified parameter is invalid.	参数无效。
400	InvalidParameter.ResourceType	The ResourceType is invalid.	传入的资源类型错误。
400	InvalidParameter.PermissionNames.Duplicate	The PermissionNames duplicate values.	参数PermissionNames重复。
400	InvalidParameter.PermissionNames.Length	The maximum length of PermissionNames exceeds quota limit.	PermissionNames长度超限。
400	InvalidParameter.TargetProperties	The TargetProperties is invalid.	TargetProperties参数无效。
400	InvalidParameter.TargetProperties.Duplicate	The TargetProperties contains duplicate values.	TargetProperties包含重复的参数。
400	InvalidParameter.TargetProperties.Length	The TargetProperties beyond the length limit.	TargetProperties数量超过限制。
400	InvalidParameter.ResourceArns	The ResourceArns is invalid.	ResourceArns参数无效。
400	InvalidParameter.ResourceArns.Duplicate	The ResourceArns contains duplicate values.	资源ARN参数有重复项。
400	InvalidParameter.ResourceArns.Length	The ResourceArns beyond the length limit.	资源ARN数量超限（最大5个）。
400	InvalidParameter.ResourceConflict	Both Resources and ResourceArns cannot be specified simultaneously. Please provide only one of these parameters.	Resources 和 ResourceArns 不能同时指定。请仅提供其中一个参数。
400	NotSupport.ResourceType.ResourcesParameter	The Resources parameter does not support this resource type. Please use ResourceArns instead.	当前资源类型不支持Resources参数，请使用ResourceArns参数。
404	EntityNotExists.ResourceShare	The resource share does not exist in the current account.	共享单元不在当前账号内。
404	EntityNotExists.Permission	The resource share permission does not exist.	共享权限不存在。
409	NotEnableSharingWithResourceDirectory	You have not enabled sharing with your Resource Directory.	未开启与资源目录组织的共享。
409	AccountNotInResourceDirectory	The account is not a master or a member of a resource directory.	资源使用者不在资源目录内。
409	ResourceShareStatusMismatchAction	The status of the resource share does not allow the specified operation.	共享单元的状态不支持当前操作。
409	QuotaExceeded.SharedResource.Count	The maximum number of shared resources per account exceeds the limit.	共享的资源超出单个账号最大限制。
409	ShareWithYourself	You cannot share resources with yourself.	资源使用者不能是自己。
409	AssociateConflict	You cannot perform the operation while disassociation operation is being performed.	取消关联中，不能操作关联。
409	NotManagementAccount	Only the management account of the service is allowed to share such resources.	当前资源类型仅支持资源目录的管理账号共享资源。如仍需使用当前账号，请联系管理账号将当前账号设置为当前资源类型所属可信服务的委派管理员账号。
409	QuotaExceeded.PendingInvitations	The maximum number of pending invitations exceeds the limit.	邀请数量超出限制。
409	InvalidTarget.LegalEntityMismatch	The target account does not have the same legal entity as the resource owner account.	共享目标账号的企业名称与共享者不一致。
409	ExternalTargetsNotAllowed.ResourceType	The resource share includes resource types that cannot be shared with accounts outside the resource directory.	共享单元中包含不支持组织外共享的资源类型。
409	InvalidTarget.SiteMismatch	Cross-site resource sharing is not supported.	共享目标账号与共享者站点不一致。
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.	同一个资源不允许重复共享给目标云服务。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。