Queries the instance Resource Access Management (RAM) roles that are attached to Elastic Compute Service (ECS) instances based on the instance IDs, or queries the ECS instances to which a specific instance RAM role is attached based on the name of the instance RAM role.
Operation description
Usage notes
When you call the API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see Parameter formats.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeInstanceRamRole | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 50. Default value: 10. | 10 |
| RegionId | string | Yes | The region ID of the instance RAM role. You can call the DescribeRegions operation to query the most recent list of regions. | cn-hangzhou |
| InstanceIds | string | No | The IDs of ECS instances. You can specify up to 100 instance IDs in a single request. Note
You must specify at least one parameter from InstanceIds and RamRoleName.
| ["i-bp67acfmxazb1p****", "i-bp67acfmxazb2p****", "bp67acfmxazb3p****"…] |
| RamRoleName | string | No | The name of the instance RAM role. If you specify this parameter, all ECS instances to which the instance RAM role is attached are returned in the response. You can call the ListRoles operation of RAM to query the names of available instance RAM roles. Note
You must specify at least one parameter from InstanceIds and RamRoleName.
| EcsServiceRole-EcsDocGuideTest |
Response parameters
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 code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidInstanceIds.Malformed | The specified instanceIds are not valid. | Multiple specified instance IDs are invalid. |
| 403 | InvalidNetworkType.MismatchRamRole | Ram 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. |
| 403 | InvalidParameter.AllEmpty | %s | The required parameters are not specified. |
| 404 | InvalidInstanceId.NotFound | The specified instanceId does not exist | The specified instance does not exist. Check whether the instance ID is correct. |
| 500 | InternalError | The 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.
Change history
| Change time | Summary of changes | Operation |
|---|