DisassociateResourceShare

Updated at:

Removes shared resources or principals from a resource share.

Operation description

  • A resource owner can call this API operation to remove shared resources or principals from a resource share.

  • When resources are shared outside a resource directory, a principal that has joined the resource share can call this API operation to leave the resource share. For more information, see Leave a resource share as a principal.

This topic provides an example of how to use the management account of a resource directory to remove the principal 172050525300**** from the resource share rs-6GRmdD3X**** in the cn-hangzhou region. This stops sharing resources with the principal.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

resourcesharing:DisassociateResourceShare

update

*All Resource

*

  • resourcesharing:RequestedResourceType
  • resourcesharing:ResourceArn
None

Request parameters

Parameter

Type

Required

Description

Example

ResourceShareId

string

Yes

The ID of the resource share.

rs-6GRmdD3X****

Resources

array<object>

No

The list of resources.

object

No

The list of resources.

ResourceType

string

No

The type of the shared resource.

Valid values of N: 1 to 5. You can remove up to 5 shared resources at a time.

For more information about the types of resources that can be shared, see Alibaba Cloud services that support Resource Sharing.

Note

Resources.N.ResourceId and Resources.N.ResourceType must be used in pairs.

VSwitch

ResourceId

string

No

The ID of the shared resource.

Valid values of N: 1 to 5. You can remove up to 5 shared resources at a time.

Note

Resources.N.ResourceId and Resources.N.ResourceType must be used in pairs.

vsw-bp183p93qs667muql****

Targets

array

No

The principals.

172050525300****

string

No

The principal.

Valid values of N: 1 to 5. You can add up to 5 principals at a time.

172050525300****

ResourceArns

array

No

The list of Alibaba Cloud Resource Names (ARNs) of the shared resources.

Valid values of N: 1 to 5. You can remove up to 5 shared resources at a time.

string

No

The ARN of the shared resource.

Note

For more information about the ARN format, see Alibaba Cloud services that support Resource Sharing.

acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****

ResourceOwner

string

No

The owner of the resource share. Valid values:

  • Self (default): The resource share belongs to the current account. This value applies to scenarios where a resource owner removes shared resources or principals during sharing within a resource directory.

  • OtherAccounts: The resource share belongs to another account. This value applies to scenarios where a principal leaves a resource share during sharing outside a resource directory.

Self

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

95230BC9-A8E8-4493-96BD-4F0C758E37F8

ResourceShareAssociations

array<object>

The information about the shared resources or principals associated with the resource share.

object

The information about the shared resources or principals associated with the resource share.

UpdateTime

string

The update time of the disassociation. Two scenarios exist:

  • If the association type AssociationType is Resource, this parameter indicates the update time when the resource is removed.

  • If the association type AssociationType is Target, this parameter indicates the update time when the principal is removed.

2020-12-04T09:40:45.556Z

ResourceArn

string

The ARN of the associated resource.

Note

This parameter is unavailable if the association type AssociationType is Target.

acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****

ResourceShareName

string

The name of the resource share.

test

CreateTime

string

The time when the disassociation is created. Two scenarios exist:

  • If the association type AssociationType is Resource, this parameter indicates the time when the resource is removed.

  • If the association type AssociationType is Target, this parameter indicates the time when the principal is removed.

2020-12-04T09:40:41.250Z

EntityType

string

The type of the associated entity. Valid values:

Account

ResourceShareId

string

The ID of the resource share.

rs-6GRmdD3X****

AssociationStatusMessage

string

The reason why the disassociation failed.

The Resources is invalid.

AssociationType

string

The association type. Valid values:

  • Resource: the resource.

  • Target: the principal.

Target

AssociationStatus

string

The association status. Valid values:

  • Associating: The association is in progress.

  • Associated: The association is complete.

  • Failed: The association failed.

  • Disassociating: The disassociation is in progress.

  • Disassociated: The disassociation is complete.

Note

Records in the Failed or Disassociated state are automatically deleted by the system within 48 to 96 hours.

Disassociating

TargetProperty

string

The properties of the principal, such as the time period for resource sharing.

Note

This parameter is returned only when the principal is an Alibaba Cloud service.

{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }

EntityId

string

The ID of the associated entity. Valid values:

  • If the association type AssociationType is Resource, this parameter indicates the resource ID.

  • If the association type AssociationType is Target, this parameter indicates the resource directory ID, folder ID, or member ID.

172050525300****

ResourceProperty

string

The properties of the resource.

{"sharePrincipals":true,"shareTagOptions":false}

Examples

Success response

JSON format

{
  "RequestId": "95230BC9-A8E8-4493-96BD-4F0C758E37F8",
  "ResourceShareAssociations": [
    {
      "UpdateTime": "2020-12-04T09:40:45.556Z",
      "ResourceArn": "acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****",
      "ResourceShareName": "test",
      "CreateTime": "2020-12-04T09:40:41.250Z",
      "EntityType": "Account",
      "ResourceShareId": "rs-6GRmdD3X****",
      "AssociationStatusMessage": "The Resources is invalid.",
      "AssociationType": "Target",
      "AssociationStatus": "Disassociating",
      "TargetProperty": "{\n    \"timeRange\":{\n        \"timeRangeType\":\"timeRange\",\n        \"beginAtTime\":\"00:00\",\n        \"timezone\":\"UTC+8\",\n        \"endAtTime\":\"19:59\"\n    }\n}",
      "EntityId": "172050525300****",
      "ResourceProperty": "{\"sharePrincipals\":true,\"shareTagOptions\":false}"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter.ResourceShareId You must specify ResourceShareId. You must specify ResourceShareId.
400 InvalidParameter.ResourceShareId The ResourceShareId is invalid. The ResourceShareId parameter is invalid.
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 ResourceAndTargetBothEmpty Either a resource or a shared target must be specified. You must specify a resource or a resource account.
400 DisassociateInvalid You can not disassociate unassociated resource or target. The disassociation operation is not supported for an entity that is not associated with the resource share.
400 InvalidParameter The specified parameter is invalid. The specified parameter is invalid.
400 InvalidParameter.ResourceType The ResourceType is invalid. The specified ResourceType parameter is invalid.
400 InvalidParameter.ResourceArns The ResourceArns is invalid. The ResourceArns parameter is invalid.
400 InvalidParameter.ResourceArns.Duplicate The ResourceArns contains duplicate values. The ResourceArns contains duplicate values.
400 InvalidParameter.ResourceArns.Length The ResourceArns beyond the length limit. The maximum number of ResourceArns exceeds 5.
400 InvalidParameter.ResourceConflict Both Resources and ResourceArns cannot be specified simultaneously. Please provide only one of these parameters. Both Resources and ResourceArns cannot be specified simultaneously. Please provide only one of these parameters.
400 NotSupport.ResourceType.ResourcesParameter The Resources parameter does not support this resource type. Please use ResourceArns instead. The Resources parameter does not support this resource type. Please use ResourceArns instead.
404 EntityNotExists.ResourceShare The resource share does not exist in the current account. The resource share does not exist in the current account.
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 ResourceShareStatusMismatchAction The status of the resource share does not allow the specified operation. The status of the resource share does not allow the specified operation.
409 DisassociateConflict You cannot perform the operation while association is already in progress. The association operation is not supported while an association is being performed.
409 LeavingFailed.Account The account was added to the resource share automatically by resoucre directory. The current account is a principal of a resource share and cannot proactively exit the resource share. Contact the owner of the resource share to remove the account from the resource share.
409 LeavingFailed.ResourceType The resource share contains resources of the resource types that dont support this action. The resource share contains resources that cannot proactively exit the resource share. Contact the owner of the resource share to remove the current account from the resource share.
409 ExternalTargetWithdrawConflict Existing internal association task in resource directory when disassociating with resource share. The current account is a principal of a resource share and cannot proactively exit the resource share. Contact the owner of the resource share to remove the account from the resource share.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.