接口说明
本接口具备两个主要功能，支持依据实例ID来查询一台或多台ECS实例所被授予的RAM角色，同时也允许通过实例RAM角色名称来查询被授予了该特定角色的实例情况。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/ram/query-role
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
serverRoleQueryReq
|
ServerRoleQueryReq
|
是
|
查询实例被授予的RAM角色信息。 |
|
instanceIds
|
<string> array
|
否
|
实例ID数组。可通过查询实例状态列表接口获取。 |
|
ramRoleName
|
string
|
否
|
为实例授予的RAM角色名称。可通过获取角色列表接口获取。 |
|
zoneId
|
string
|
否
|
可用区，可通过查询属地地域可用区信息接口获取。示例值：苏州可用区1的zoneId为cn-jiangsu-1a。 |
|
page
|
integer(int32)
|
否
|
列表分页页数。默认值：1。 |
|
size
|
integer(int32)
|
否
|
列表分页每页大小。默认值：20。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/ram/query-role{
"page":1,
"size":1
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«ServerRoleInfo»
|
请求成功时返回的数据。 |
|
content
|
<ServerRoleInfo> array
|
分页查询返回的具体结构体。 |
|
instanceId
|
string
|
实例ID。 |
|
ramRoleName
|
string
|
RAM角色名称。 |
|
updateTime
|
string(date-time)
|
RAM角色刷新时间。 |
|
userId
|
string
|
用户ID。 |
|
zoneId
|
string
|
可用区ID。 |
|
total
|
integer
|
满足查询条件的总个数。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-23d28d2d329542dabffeb670cf7bbb82",
"state":"OK",
"body":{
"total":1,
"content":[
{
"instanceId":"062593d2-abd5-4554-8459-980c38f1000b",
"ramRoleName":"test._-1H",
"zoneId":"N001-JS-CK-TCCS01",
"userId":"CIDC-U-8a0eacbf92df46fa9kfb672b7d173e49",
"updateTime":"2025-03-13 10:29:49"
}
]
}
}