本接口用于收回一台或多台ECS实例被授予的RAM角色。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DetachInstanceRamRole |
update |
*Instance
*Role
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| RamRoleName |
string |
否 |
指定收回的实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色名称。 |
RamRoleTest |
| InstanceIds |
string |
是 |
指定收回的实例 ID 数组。数组长度:1~100。 |
["i-bp67acfmxazb4p****", "i-bp67acfmxazb5p****", "i-bp67acfmxazb6p****"…] |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RamRoleName |
string |
收回实例 RAM 角色名称。 |
RamRoleTest |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
收回实例总个数。 |
1 |
| FailCount |
integer |
收回失败的实例个数。 |
0 |
| DetachInstanceRamRoleResults |
object |
||
| DetachInstanceRamRoleResult |
array<object> |
由被收回的实例 ID 和收回实例 RAM 角色名称等(DetachInstanceRamRoleResult)组成的信息集。 |
|
|
array<object> |
|||
| Code |
string |
判断是否成功收回实例 RAM 角色。返回值为 200 表示成功收回,返回其他值表示收回失败,失败原因参见错误码。 |
200 |
| Message |
string |
判断是否成功收回实例 RAM 角色。返回值为 Success 表示成功收回,返回其他值表示收回失败,失败原因参见错误码。 |
Success |
| InstanceId |
string |
被收回实例 RAM 角色的实例 ID。 |
i-bp67acfmxazb4p**** |
| Success |
boolean |
是否成功收回实例 RAM 角色。 |
true |
| InstanceRamRoleSets |
object |
||
| InstanceRamRoleSet |
array<object> |
收回的实例 ID 和实例 RAM 角色名称集合。 |
|
|
object |
|||
| RamRoleName |
string |
收回实例 RAM 角色名称。 |
RamRoleTest |
| InstanceId |
string |
被收回的实例 ID。 |
i-bp67acfmxazb4p**** |
示例
正常返回示例
JSON格式
{
"RamRoleName": "RamRoleTest",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1,
"FailCount": 0,
"DetachInstanceRamRoleResults": {
"DetachInstanceRamRoleResult": [
{
"Code": "200",
"Message": "Success",
"InstanceId": "i-bp67acfmxazb4p****",
"Success": true,
"InstanceRamRoleSets": {
"InstanceRamRoleSet": [
{
"RamRoleName": "RamRoleTest",
"InstanceId": "i-bp67acfmxazb4p****"
}
]
}
}
]
}
}
异常返回示例
JSON格式
{
"RequestId": "E6352369-5C2B-41CD-AB50-471550C8F674",
"DetachInstanceRamRoleResults": {
"DetachInstanceRamRoleResult": [
{
"Message": "success",
"InstanceId": "i-instance1",
"Code": "200"
}
]
},
"TotalCount": 1,
"FailCount": 0,
"RamRoleName": "RamRoleTest"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。