全部产品
Search
文档中心

资源管理:GetRole - 获取角色信息

更新时间:Aug 28, 2026

调用GetRole获取角色信息。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

RoleName

string

角色名称。

长度为 1~64 个字符,可包含英文字母、数字、点号(.)和短横线(-)。

ECSAdmin

Language

string

语言类型。角色描述将以此语言返回。

  • en:英文。

  • zh-CN:中文。

  • ja:日文。

zh-CN

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368

Role

object

角色信息。

Arn

string

角色的资源描述符。

acs:ram::123456789012****:role/ECSAdmin

AssumeRolePolicyDocument

string

扮演角色的权限策略内容。

{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::12345678901234****:root\" } } ], \"Version\": \"1\" }

CreateDate

string

角色创建时间。

2015-01-23T12:33:18Z

Description

string

角色描述。

ECS管理角色

IsServiceLinkedRole

boolean

是否为服务关联角色。

true

LatestDeletionTask

object

最近一次删除任务信息。

CreateDate

string

删除任务创建时间。

2018-10-23T12:33:18Z

DeletionTaskId

string

删除任务 ID。

ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d

MaxSessionDuration

integer

角色最大会话时间。

3600

RoleId

string

角色 ID。

90123456789****

RoleName

string

角色名称。

ECSAdmin

RolePrincipalName

string

被授权角色名称。

ECSAdmin@role.123456.onaliyunservice.com

UpdateDate

string

角色更新时间。

2016-01-23T12:33:18Z

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Role": {
    "Arn": "acs:ram::123456789012****:role/ECSAdmin",
    "AssumeRolePolicyDocument": "{ \\\"Statement\\\": [ { \\\"Action\\\": \\\"sts:AssumeRole\\\", \\\"Effect\\\": \\\"Allow\\\", \\\"Principal\\\": { \\\"RAM\\\": \\\"acs:ram::12345678901234****:root\\\" } } ], \\\"Version\\\": \\\"1\\\" }",
    "CreateDate": "2015-01-23T12:33:18Z",
    "Description": "ECS管理角色",
    "IsServiceLinkedRole": true,
    "LatestDeletionTask": {
      "CreateDate": "2018-10-23T12:33:18Z",
      "DeletionTaskId": "ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d"
    },
    "MaxSessionDuration": 3600,
    "RoleId": "90123456789****",
    "RoleName": "ECSAdmin",
    "RolePrincipalName": "ECSAdmin@role.123456.onaliyunservice.com",
    "UpdateDate": "2016-01-23T12:33:18Z"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.RoleName.InvalidChars The specified role name contains invalid characters. 角色名称包含无效字符。
400 InvalidParameter.RoleName.Length The maximum length of the role name is exceeded. 角色名称长度超出限制。
404 EntityNotExist.Role The role does not exist. 角色不存在。

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

变更历史

更多信息,参考变更详情