All Products
Search
Document Center

Elastic Compute Service:DescribeInstanceRamRole

Last Updated:Mar 13, 2024

Queries the instance RAM roles that are attached to Elastic Compute Service (ECS) instances.

Operation description

Description

When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in required formats. For more information, see Parameter format overview.

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
PageNumberintegerNo

The number of the page to return.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Maximum value: 50.

Default value: 10.

10
RegionIdstringYes

The region ID of the instance RAM role. You can call the DescribeRegions operation to query the most recent list of regions.

cn-hangzhou
InstanceIdsstringNo

The IDs of instances. You can specify up to 100 instance IDs in a single request. You must specify at least one of the InstanceIds and RamRoleName parameters.

["i-bp67acfmxazb1p****", "i-bp67acfmxazb2p****", "bp67acfmxazb3p****"…]
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. You must specify at least one of the InstanceIds and RamRoleName parameters.

EcsServiceRole-EcsDocGuideTest

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The total number of instance RAM roles returned.

1
RegionIdstring

The region ID of the instance RAM role.

cn-hangzhou
InstanceRamRoleSetsobject []

Details about the instance RAM roles.

RamRoleNamestring

The name of the instance RAM role.

EcsServiceRole-EcsDocGuideTest
InstanceIdstring

The ID of the instance

i-bp67acfmxazb4p****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "RegionId": "cn-hangzhou",
  "InstanceRamRoleSets": {
    "InstanceRamRoleSet": [
      {
        "RamRoleName": "EcsServiceRole-EcsDocGuideTest",
        "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.
403InvalidParameter.AllEmpty%sThe required parameters are not specified.
404InvalidInstanceId.NotFoundThe specified instanceId does not existThe specified instance does not exist. Check whether the instance ID is correct.
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.

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