文档

JoinResourceGroup - 将一个ECS资源或者服务加入一个资源组

更新时间:

调用JoinResourceGroup将一个ECS资源或者服务加入一个资源组。

接口说明

资源是您在阿里云创建的云服务实体,例如,一台 ECS 实例、一个 ECS 弹性网卡或者一份 ECS 镜像等都可以是资源。资源组是项目、环境或者栈的基础设施集合,在资源组里管理资源能集中监控和执行任务,免去了您在多种阿里云服务间反复查看的负担。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:JoinResourceGroupWrite
  • 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}
  • ecs:tag

请求参数

名称类型必填描述示例值
ResourceTypestring

ECS 资源的类型。取值范围:

  • instance:实例。
  • disk:块存储。
  • snapshot:快照。
  • image:镜像。
  • securitygroup:安全组。
  • ddh:专有宿主机。
  • ddhcluster:专有宿主机集群。
  • eni:弹性网卡。
  • keypair:密钥对。
  • launchtemplate:启动模板。
  • command:云助手命令。
  • activation:云助手托管实例激活码。

以上参数取值均大小写敏感。

securitygroup
ResourceIdstring

资源类型的 ID 标识符。例如,当 ResourceType=instance 时,则 ResourceId 可以理解为 InstanceId。

sg-bp67acfmxazb4p****
RegionIdstring

资源所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ResourceGroupIdstring

目标资源组 ID。

rg-bp67acfmxazb4p****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
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.资源组正在创建或删除时不允许操作。
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.指定的资源类型不存在。
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.资源组并不在记录中。
404InvalidResourceId.NotFoundThe ResourceId provided does not exist in our records.指定的资源不存在。

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

变更历史

变更时间变更内容概要操作
2023-11-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
2023-05-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
    新增错误码:400
2023-03-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
  • 本页导读 (1)
文档反馈