ListRoles - 获取角色列表--访问控制-火山引擎

文档中心

立即注册

导航

ListRoles - 获取角色列表

最近更新时间：2025.01.03 15:13:38首次发布时间：2021.02.23 10:42:33

获取角色列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListRoles	要执行的操作，取值：ListRoles。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
Query	String	否	ops-role	模糊查询。可按角色名、显示名或备注查询。
Limit	Integer	否	10	分页条数，默认为10。
Offset	Integer	否	5	分页起始索引，默认为0。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
RoleMetadata	Array of Object	请参考数据结构内具体参数示例值。	角色的数据结构。
Limit	Integer	10	分页条数。
Offset	Integer	0	分页起始索引。
Total	Integer	20	总数。

请求示例

GET /?Action=ListRoles&Version=2018-01-01&Query=ops-role&Limit=10&Offset=5 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20250103T061209Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250103/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025010314121221219911414403A238",
    "Action": "ListRoles",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "RoleMetadata": [
      {
        "RoleId": 30000,
        "RoleName": "ops-role",
        "Trn": "trn:iam::2000000000:role/ops-role",
        "DisplayName": "运维角色",
        "Description": "运维角色",
        "TrustPolicyDocument": "{\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"sts:AssumeRole\"],\"Principal\":{\"IAM\":[\"trn:iam::2000000000:root\"]}}]}",
        "MaxSessionDuration": 3600,
        "IsServiceLinkedRole": 1,
        "CreateDate": "20240910T133549Z",
        "UpdateDate": "20240910T133549Z",
        "Tags": [
          {
            "Key": "department",
            "Value": "dev"
          }
        ]
      }
    ],
    "Limit": 10,
    "Offset": 0,
    "Total": 20
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。