DetachInstanceRamRole - 收回实例被授予的RAM角色 - 云服务器 ECS

本接口用于收回一台或多台ECS实例被授予的RAM角色。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DetachInstanceRamRole	update	Instance `acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}` Role `acs:ram:{#regionId}:{#accountId}:role/{#roleName}`	无	无

请求参数

名称	类型	必填	描述	示例值
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	array<object>	由被收回的实例 ID 和收回实例 RAM 角色名称等（DetachInstanceRamRoleResult）组成的信息集。
DetachInstanceRamRoleResult	object
Code	string	判断是否成功收回实例 RAM 角色。返回值为 200 表示成功收回，返回其他值表示收回失败，失败原因参见错误码。	200
Message	string	判断是否成功收回实例 RAM 角色。返回值为 Success 表示成功收回，返回其他值表示收回失败，失败原因参见错误码。	Success
InstanceId	string	被收回实例 RAM 角色的实例 ID。	i-bp67acfmxazb4p****
Success	boolean	是否成功收回实例 RAM 角色。	true
InstanceRamRoleSets	array<object>	收回的实例 ID 和实例 RAM 角色名称集合。
InstanceRamRoleSet	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****"
            }
          ]
        }
      }
    ]
  }
}

错误码

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.	指定的实例ID未找到。

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

变更历史

变更时间	变更内容概要	操作
2024-12-17	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情