All Products
Search
Document Center

Elastic Compute Service:JoinResourceGroup

Last Updated:Sep 29, 2024

Adds an Elastic Compute Service (ECS) resource or service to a resource group.

Operation description

Usage notes

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 image. A resource group is a collection of infrastructure for projects, environments, or stacks. In a resource group, you can manage resources and monitor and run tasks in a centralized manner without the need to switch between Alibaba Cloud services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:JoinResourceGroupupdate
  • DedicatedHost
    acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}
  • Disk
    acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}
  • NetworkInterface
    acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}
  • Image
    acs:ecs:{#regionId}:{#accountId}:image/{#imageId}
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • KeyPair
    acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairId}
  • LaunchTemplate
    acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId}
  • SecurityGroup
    acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}
  • Snapshot
    acs:ecs:{#regionId}:{#accountId}:snapshot/{#SnapshotId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringNo

The type of the ECS resource. Valid values:

  • instance: instance
  • disk: Elastic Block Storage (EBS) device
  • snapshot: snapshot
  • image: image
  • securitygroup: security group
  • ddh: dedicated host
  • ddhcluster: dedicated host cluster
  • eni: ENI
  • keypair: SSH key pair
  • launchtemplate: launch template
  • command: Cloud Assistant command
  • activation: activation code for a Cloud Assistant managed instance
  • managedinstance: Cloud Assistant managed instance

The values are case-sensitive.

securitygroup
ResourceIdstringNo

The ID of the resource. For example, if you set ResourceType to instance, set this parameter to the ID of the instance.

sg-bp67acfmxazb4p****
RegionIdstringNo

The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group to which you want to add the instance.

rg-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400EntityExists.AssociatedTransferTasksAn associated transfer task is in progress. Try again later.-
403MissingParameterThe input parameter "ResourceId" that is mandatory for processing this request is not supplied.-
403MissingParameterThe input parameter "ResourceGroupId" that is mandatory for processing this request is not supplied.-
403MissingParameterThe input parameter "RegionId" that is mandatory for processing this request is not supplied.-
403InvalidResourceGroup.DuplicateThe ResourceId provided has a ResourceGroup in our records.-
403InvalidRegionId.ResourceGroupThe specified region does not support resource group yet.-
403InvalidStatus.ResourceGroupYou 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.
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.The specified resource type does not exist.
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The specified resource group does not exist.
404InvalidResourceId.NotFoundThe ResourceId provided does not exist in our records.The specified resource does not exist.

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

Change history

Change timeSummary of changesOperation
2023-11-20The Error code has changedView Change Details
2023-05-22The Error code has changedView Change Details
2023-03-17The Error code has changedView Change Details