Query instance RAM roles and attached ECS instances with DescribeInstanceRamRole - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeInstanceRamRole

get

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Role

acs:ram:{#regionId}:{#accountId}:role/{#roleName}

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 50 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 elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The number of ECS instances returned.	1
RegionId	string	The region ID of the ECS instances.	cn-hangzhou
InstanceRamRoleSets	object
InstanceRamRoleSet	array<object>	The IDs of the ECS instances and the names of the corresponding instance RAM roles.
	object
RamRoleName	string	The name of the instance RAM role.	EcsServiceRole-EcsDocGuideTest
InstanceId	string	The ID of the instance	i-bp67acfmxazb4p****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "RegionId": "cn-hangzhou",
  "InstanceRamRoleSets": {
    "InstanceRamRoleSet": [
      {
        "RamRoleName": "EcsServiceRole-EcsDocGuideTest",
        "InstanceId": "i-bp67acfmxazb4p****"
      }
    ]
  }
}

Error response

JSON format

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", 
    "HostId": "ecs.aliyuncs.com",
    "Code": "IncompleteSignature",
    "Message": "The request signature does not conform to Aliyun standards."
}

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.
500	InternalError	The request processing has failed due to some unknown error.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.