文档

CreateRole - 创建角色

更新时间:

调用CreateRole创建角色。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ram:CreateRoleWrite
  • Role
    acs:ram:*:{#accountId}:role/{#RoleName}

请求参数

名称类型必填描述示例值
RoleNamestring

角色名称。

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

ECSAdmin
Descriptionstring

角色描述。

长度为 1~1024 个字符。

ECS管理角色
AssumeRolePolicyDocumentstring

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

指定允许扮演该角色的一个或多个主体,这个主体可以是阿里云账号、阿里云服务或身份提供商。

说明 RAM 用户不能扮演可信实体为阿里云服务的 RAM 角色。
{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }
MaxSessionDurationlong

角色最大会话时间。

取值范围:3600 秒~43200 秒。默认值:3600 秒。

取值为空时将采用默认值。

3600

返回参数

名称类型描述示例值
object
Roleobject

角色信息。

AssumeRolePolicyDocumentstring

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

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

被授权角色名称。

ECSAdmin@role.123456.onaliyunservice.com
Descriptionstring

角色描述。

ECS管理角色
MaxSessionDurationlong

角色最大会话时间。

3600
RoleNamestring

角色名称。

ECSAdmin
CreateDatestring

角色创建时间。

2015-01-23T12:33:18Z
Arnstring

角色的资源描述符。

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

角色 ID。

90123456789****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.RoleName.InvalidCharsThe specified role name contains invalid characters.角色名称包含无效字符。
400InvalidParameter.RoleName.LengthThe maximum length of the role name is exceeded.角色名称长度超出限制。
400InvalidParameter.AssumeRolePolicyDocument.LengthThe maximum length of the trust policy document of the role is exceeded.角色信任策略长度超出限制。
409EntityAlreadyExists.RoleThe role already exists.角色已存在。
409MalformedPolicyDocumentThe policy format is invalid.策略格式错误。
409LimitExceeded.RoleThe maximum number of roles is exceeded.角色数量超出限制。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读
文档反馈