GetRole - 查询角色详情--访问控制-火山引擎

文档中心

立即注册

导航

GetRole - 查询角色详情

最近更新时间：2024.11.21 21:18:32首次发布时间：2021.02.23 10:42:32

查询指定角色的详情信息。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetRole	要执行的操作，取值：GetRole。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
RoleName	String	是	ops-role	角色名。

返回参数

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

参数	类型	示例值	描述
Role	Object	请参考数据结构内具体参数示例值。	角色的数据结构。

请求示例

GET /?Action=GetRole&Version=2018-01-01&RoleName=ops-role HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240911T101141Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240911/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240911181147209228188031B1D50D",
    "Action": "GetRole",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "Role": {
      "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"
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
404	RoleNotExist	Role '%s' cannot be found	角色不存在。