获取角色列表
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListRoles | 要执行的操作,取值:ListRoles。 |
Version | String | 是 | 2024-08-31 | API的版本,取值:2024-08-31。 |
ClusterID | Integer | 否 | 12345 | 集群id |
Name | String | 否 | system_admin | 角色名 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Message | String | top响应信息 | |
Data | Object | { | 返回数据 |
GET /?Action=ListRoles&Version=2024-08-31&ClusterID=12345&Name=system_admin HTTP/1.1 Host: open.volcengineapi.com X-Date: 20240929T034043Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240929/cn-beijing/bytehouse_ce/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{ "ResponseMetadata": { "RequestId": "202409291140510830222400585D1BFF", "Action": "ListRoles", "Version": "2024-08-31", "Service": "bytehouse_ce", "Region": "cn-beijing" }, "Result": { "Message": "", "Data": { "Roles": [ { "ID": 123456, "Description": "description", "IsDefault": true, "Name": "system_admin", "ClusterID": 123456, "AccountID": 123456, "ClusterName": "cluster", "CreatedAt": 1721294525980, "UpdatedAt": 1721294525980, "CreatedBy": "dba", "UpdatedBy": "dba", "GrantUsers": [ "user1","user2" ] } ] } } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | Bad Request | 参数错误 |
401 | SignatureNotMatch | |
500 | InternalError | |
503 | ServiceUnavailable |