Call JoinResourceGroup to add an ECS resource to a resource group - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

A resource is a cloud service entity that you create on Alibaba Cloud, such as an ECS instance, an Elastic Network Interface (ENI), or an ECS image. A resource group is a collection of infrastructure for projects, environments, or stacks. Managing resources in resource groups allows you to centrally monitor resources and execute tasks, which eliminates the need to switch between multiple Alibaba Cloud services.

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

ecs:JoinResourceGroup

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The type of the ECS resource. Valid values: instance: instance disk: block storage snapshot: snapshot image: image securitygroup: security group ddh: dedicated host ddhcluster: dedicated host cluster eni: Elastic Network Interface (ENI) keypair: key pair launchtemplate: launch template command: Cloud Assistant command activation: activation code for managed instances managedinstance: managed instance The values are case-sensitive.	securitygroup
ResourceId	string	No	The ID of the resource. For example, if ResourceType is set to instance, ResourceId specifies the instance ID.	sg-bp67acfmxazb4p****
RegionId	string	No	The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The ID of the destination resource group.	rg-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EntityExists.AssociatedTransferTasks	An associated transfer task is in progress. Try again later.	There are unfinished association or resource group transfer tasks. Try again later.
403	MissingParameter	The input parameter "ResourceId" that is mandatory for processing this request is not supplied.
403	InvalidResourceGroup.Duplicate	The ResourceId provided has a ResourceGroup in our records.	The resource has already been added to another resource group.
403	InvalidRegionId.ResourceGroup	The specified region does not support resource group yet.
403	InvalidStatus.ResourceGroup	You cannot perform an operation on a resource group that is being created or deleted.	Operation not allowed while resource group is being created or deleted.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	The specified resource type does not exist.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	The specified resource group does not exist.
404	InvalidResourceId.NotFound	The ResourceId provided does not exist in our records.	The specified resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.