DescribeInstanceRamRole - 查询实例上的实例RAM角色 - 云服务器 ECS

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	查询接口返回资源信息列表的页码。起始值：1 默认值：1	1
PageSize	integer	否	分页展示响应信息时设置的每页行数，单位：行。最大值：50 默认值：10	10
RegionId	string	是	实例 RAM 角色所在的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
InstanceIds	string	否	指定查询的实例 ID 的集合。最多支持一次查询 100 台实例。`InstanceIds`与`RamRoleName`参数必须至少填写一个。	["i-bp67acfmxazb1p**", "i-bp67acfmxazb2p", "bp67acfmxazb3p**"…]
RamRoleName	string	否	查询赋予了某一实例 RAM 角色的所有 ECS 实例。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。`InstanceIds`与`RamRoleName`参数必须至少填写一个。	EcsServiceRole-EcsDocGuideTest

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返回的 RAM 角色数量。	1
RegionId	string	实例 RAM 角色所在的地域。	cn-hangzhou
InstanceRamRoleSets	array<object>	由实例 RAM 角色类型 InstanceRamRoleSet 组成的信息集。
InstanceRamRoleSet	object
RamRoleName	string	实例 RAM 角色名称列表。	EcsServiceRole-EcsDocGuideTest
InstanceId	string	实例 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	错误码	错误信息	描述
400	InvalidInstanceIds.Malformed	The specified instanceIds are not valid.	指定的多个 InstanceId 不合法。
403	InvalidNetworkType.MismatchRamRole	Ram role cannot be applied to instances of Classic network type.	实例 RAM 角色不能被用于经典网络类型的实例，RAM 角色只能使用在 VPC 类型的实例上。
403	InvalidParameter.AllEmpty	%s	您没有输入任何参数，请输入必要的参数。
404	InvalidInstanceId.NotFound	The specified instanceId does not exist	指定的实例不存在，请您检查实例 ID 是否正确。
500	InternalError	The request processing has failed due to some unknown error.	内部错误，请重试。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史