全部产品
Search
文档中心

云服务器 ECS:DescribeInstanceRamRole - 查询实例被授予的RAM角色

更新时间:Dec 06, 2024

本接口具备两个主要功能,支持依据实例 ID 来查询一台或多台 ECS 实例所被授予的实RAM角色,同时也允许通过实例 RAM 角色名称来查询被授予了该特定角色的实例情况。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeInstanceRamRoleget
*全部资源
*

请求参数

名称类型必填描述示例值
PageNumberinteger

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

起始值:1。

默认值:1。

1
PageSizeinteger

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

最大值:50。

默认值:10。

10
RegionIdstring

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

cn-hangzhou
InstanceIdsstring

指定查询的实例 ID 的集合。最多支持一次查询 100 台实例。

说明 InstanceIdsRamRoleName参数必须至少填写一个。
["i-bp67acfmxazb1p****", "i-bp67acfmxazb2p****", "bp67acfmxazb3p****"…]
RamRoleNamestring

查询赋予了某一实例 RAM 角色的所有 ECS 实例。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。

说明 InstanceIdsRamRoleName参数必须至少填写一个。
EcsServiceRole-EcsDocGuideTest

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

返回的实例数量。

1
RegionIdstring

实例所在的地域。

cn-hangzhou
InstanceRamRoleSetsarray<object>

由实例 ID 和 RAM 角色名称(InstanceRamRoleSet)组成的信息集。

InstanceRamRoleSetobject
RamRoleNamestring

实例 RAM 角色名称。

EcsServiceRole-EcsDocGuideTest
InstanceIdstring

实例 ID。

i-bp67acfmxazb4p****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidInstanceIds.MalformedThe specified instanceIds are not valid.指定的多个 InstanceId 不合法。
403InvalidNetworkType.MismatchRamRoleRam role cannot be applied to instances of Classic network type.实例 RAM 角色不能被用于经典网络类型的实例,RAM 角色只能使用在 VPC 类型的实例上。
403InvalidParameter.AllEmpty%s您没有输入任何参数,请输入必要的参数。
404InvalidInstanceId.NotFoundThe specified instanceId does not exist指定的实例不存在,请您检查实例 ID 是否正确。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史