全部产品
Search
文档中心

云服务器 ECS:DetachInstanceRamRole

更新时间:Sep 04, 2023

调用DetachInstanceRamRole回收一台或多台ECS实例的实例RAM角色。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DetachInstanceRamRole

系统规定参数。取值:DetachInstanceRamRole

RegionId String cn-hangzhou

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

RamRoleName String RamRoleTest

收回赋予了某一实例RAM角色的所有ECS实例。您可以使用RAM API ListRoles查询您已创建的实例RAM角色。

InstanceIds String ["i-bp67acfmxazb4p****", "i-bp67acfmxazb5p****", "i-bp67acfmxazb6p****"…]

指定收回的实例ID。取值可以由多个实例ID组成一个JSON数组,最多支持100个ID,ID之间用半角逗号(,)隔开。

返回数据

名称

类型

示例值

描述

RamRoleName String RamRoleTest

收回实例RAM角色的名称。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount Integer 1

收回的实例RAM角色的总个数。

FailCount Integer 0

收回失败的实例RAM角色的个数。

DetachInstanceRamRoleResults Array of DetachInstanceRamRoleResult

由实例RAM角色类型(DetachInstanceRamRoleResult)组成的信息集。

DetachInstanceRamRoleResult
Code String 200

判断是否成功收回实例RAM角色。返回值为200表示成功收回,返回其他值表示收回失败,失败原因参见错误码。

Message String Success

判断是否成功收回实例RAM角色。返回值为Success表示成功收回,返回其他值表示收回失败,失败原因参见错误码。

InstanceId String i-bp67acfmxazb4p****

准备收回实例RAM角色的ECS实例。

Success Boolean true

是否成功回收了指定的实例角色。

InstanceRamRoleSets Array of InstanceRamRoleSet

实例的RAM角色集合。

InstanceRamRoleSet
RamRoleName String RamRoleTest

收回实例RAM角色的名称。

InstanceId String i-bp67acfmxazb4p****

实例ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DetachInstanceRamRole
&InstanceIds=["i-bp67acfmxazb4p****", "i-bp67acfmxazb5p****", "i-bp67acfmxazb6p****"…]
&RegionId=cn-hangzhou
&RamRoleName=RamRoleTest
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DetachInstanceRamRoleResponse>
    <TotalCount>1</TotalCount>
    <DetachInstanceRamRoleResults>
        <DetachInstanceRamRoleResult>
            <Message>success</Message>
            <InstanceId>i-bp16qng6jnvt6g7t****</InstanceId>
            <Code>200</Code>
            <InstanceRamRoleSets>
                <InstanceId>i-bp16qng6jnvt6g7t****</InstanceId>
                <RamRoleName>RamRoleTest</RamRoleName>
            </InstanceRamRoleSets>
        </DetachInstanceRamRoleResult>
    </DetachInstanceRamRoleResults>
    <RequestId>14D5B163-CE6C-4489-B979-DBE5D0495A63</RequestId>
    <RamRoleName/>
    <FailCount>0</FailCount>
</DetachInstanceRamRoleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "DetachInstanceRamRoleResults" : {
    "DetachInstanceRamRoleResult" : [ {
      "Message" : "success",
      "InstanceId" : "i-bp16qng6jnvt6g7t****",
      "Code" : "200",
      "InstanceRamRoleSets" : {
        "InstanceId" : "i-bp16qng6jnvt6g7t****",
        "RamRoleName" : "RamRoleTest"
      }
    } ]
  },
  "RequestId" : "14D5B163-CE6C-4489-B979-DBE5D0495A63",
  "RamRoleName" : "",
  "FailCount" : 0
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidInstanceIds.Malformed The specified instanceIds are not valid. 指定的多个 InstanceId 不合法。
403 InvalidNetworkType.MismatchRamRole Ram role cannot be applied to instances of Classic network type. 实例 RAM 角色不能被用于经典网络类型的实例,RAM 角色只能使用在 VPC 类型的实例上。
403 InvalidUser.PassRoleForbidden The RAM user does not have the privilege to pass a RAM role. 该 RAM 用户无权传递 RAM 角色。
404 InvalidInstanceId.NotFound The specified instanceId does not exist. 指定的实例ID未找到。

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