All Products
Search
Document Center

Elastic Compute Service:DetachInstanceRamRole

Last Updated:Apr 11, 2024

Detaches an instance RAM role from one or more ECS instances.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
RamRoleNamestringNo

The name of the instance RAM role. You can call the ListRoles operation provided by RAM to query the instance RAM roles that you created.

RamRoleTest
InstanceIdsstringYes

The IDs of instances. The value can be a JSON array that consists of up to 100 instance IDs. Separate the IDs with commas (,).

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

Response parameters

ParameterTypeDescriptionExample
object
RamRoleNamestring

The name of the instance RAM role.

RamRoleTest
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

The total number of instances from which you attempted to detach instance RAM roles.

1
FailCountinteger

The number of instances from which instance RAM roles failed to be detached.

0
DetachInstanceRamRoleResultsobject []

Details about the results of detaching instance RAM roles from the instances.

Codestring

Indicates whether the instance RAM role was detached. If 200 is returned, the instance RAM role was detached. If any other value is returned, the instance RAM role failed to be detached. For more information, see the "Error codes" section.

200
Messagestring

Indicates whether the instance RAM role was detached. If success is returned, the instance RAM role was detached. If any other value is returned, the instance RAM role failed to be detached. For more information, see the "Error codes" section.

Success
InstanceIdstring

The ID of the instance from which you attempted to detach the instance RAM role.

i-bp67acfmxazb4p****
Successboolean

Indicates whether the instance RAM role was detached.

true
InstanceRamRoleSetsobject []

Details about the instance RAM role of the instance.

RamRoleNamestring

The name of the instance RAM role.

RamRoleTest
InstanceIdstring

The instance ID.

i-bp67acfmxazb4p****

Examples

Sample success responses

JSONformat

{
  "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****"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidInstanceIds.MalformedThe specified instanceIds are not valid.Multiple specified instance IDs are invalid.
403InvalidNetworkType.MismatchRamRoleRam role cannot be applied to instances of Classic network type.Instance RAM roles can be used only for instances of the VPC type, not for instances of the classic network type.
403InvalidUser.PassRoleForbiddenThe RAM user does not have the privilege to pass a RAM role.The RAM user is not authorized to pass a RAM role.
404InvalidInstanceId.NotFoundThe specified instanceId does not exist.The specified instance does not exist.

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

Change history

Change timeSummary of changesOperation
No change history