调用DescribeInstanceRamRole查询一台或者多台ECS实例上的已赋予的实例RAM角色。

接口说明

通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循格式要求,详情请参见CLI参数格式说明

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstanceRamRole

接口名称。对于您自行拼凑HTTP/HTTPS URL发起的API请求,Action为必选参数。取值:DescribeInstanceRamRole

RegionId String cn-hangzhou

实例RAM角色所在的地域。您可以调用DescribeRegions查看最新的阿里云地域列表。

PageNumber Integer 1

查询接口返回资源信息列表的页码。

起始值:1。

默认值:1。

PageSize Integer 10

分页展示响应信息时设置的每页行数,单位:行。

最大值:50。

默认值:10。

InstanceIds String ["i-bp67acfmxazb4ph***", "i-bp67acfmxazb4pi***", "bp67acfmxazb4pj***"…]

指定查询的实例ID的集合。最多支持一次查询100台实例。InstanceIdsRamRoleName参数必须至少填写一个。

RamRoleName String EcsServiceRole-EcsDocGuideTest

查询赋予了某一实例RAM角色的所有ECS实例。您可以使用RAM API ListRoles查询您已创建的实例RAM角色。InstanceIdsRamRoleName参数必须至少填写一个。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

RegionId String cn-hangzhou

实例RAM角色所在的地域。

TotalCount Integer 1

返回的RAM角色数量。

InstanceRamRoleSets Array

由实例RAM角色类型InstanceRamRoleSet组成的信息集。

InstanceId String i-bp67acfmxazb4ph***

实例ID。

RamRoleName String EcsServiceRole-EcsDocGuideTest

实例RAM角色名称列表。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInstanceRamRole
&RegionId=cn-hangzhou
&InstanceIds=["i-bp67acfmxazb4ph***"]
&PageNumber=1
&PageSize=1
&<公共请求参数>

正常返回示例

XML 格式

<DescribeInstanceRamRoleResponse>
      <RequestId>8F4CAE3F-7892-4662-83A5-2C2FFD639553</RequestId>
      <InstanceRamRoleSets>
            <InstanceRamRoleSet>
                  <InstanceId>i-bp67acfmxazb4ph***</InstanceId>
                  <RamRoleName>EcsServiceRole-EcsDocGuideTest</RamRoleName>
            </InstanceRamRoleSet>
      </InstanceRamRoleSets>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>1</PageSize>
</DescribeInstanceRamRoleResponse>

JSON 格式

{
    "RequestId": "8F4CAE3F-7892-4662-83A5-2C2FFD639553",
    "InstanceRamRoleSets": {
        "InstanceRamRoleSet": [
            {
                "InstanceId": "i-bp67acfmxazb4ph***",
                "RamRoleName": "EcsServiceRole-EcsDocGuideTest"
            }
        ]
    },
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 1
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidInstanceIds.Malformed The specified instanceIds are not valid. 指定的多个 InstanceId 不合法。
404 InvalidInstanceId.NotFound The specified instanceId does not exist 指定的实例不存在,请您检查实例ID是否正确。
403 InvalidNetworkType.MismatchRamRole Ram role cannot be applied to instances of Classic network type. 实例 RAM 角色不能被用于经典网络实例,RAM 角色只能使用在 VPC 实例上。
403 InvalidParameter.AllEmpty %s 您没有输入任何参数,请输入必要的参数。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单。

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