CreateRole - 创建角色--访问控制-火山引擎

文档中心

立即注册

导航

CreateRole - 创建角色

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

创建角色。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateRole	要执行的操作，取值：CreateRole。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
RoleName	String	是	ops-role	角色名。
DisplayName	String	是	运维角色	角色显示名。
Description	String	否	运维角色	角色描述。
TrustPolicyDocument	String	否	{"Statement":[{"Effect":"Allow","Action":["sts:AssumeRole"],"Principal":{"IAM":["trn:iam::2000000000:root"]}}]}	角色信任策略。信任策略遵循IAM的策略语法中基于资源的策略规则。以下是角色信任账号2000000001的信任策略示例： `{ "Statement": [ { "Effect": "Allow", "Action": [ "sts:AssumeRole" ], "Principal": { "IAM": [ "trn:iam::2000000001:root" ] } } ] }` 以下是角色信任ecs服务的信任策略示例： `{ "Statement": [ { "Effect": "Allow", "Action": [ "sts:AssumeRole" ], "Principal": { "Service": [ "ecs" ] } } ] }`
MaxSessionDuration	Integer	否	3600	角色最大会话时间。用于限制角色扮演产生的临时安全凭证的有效期的最大范围。取值范围：3600~43200，单位为秒，默认为43200。
Tags.N.Key	Array of String	否	department	给角色附加标签的标签键。使用UTF-8编码的Unicode，长度为1~128字符，允许任何语言文字、数字、空格和_ . : / = + - @符号。每个角色至多附加50对标签。
Tags.N.Value	Array of String	否	ops	给角色附加标签的标签值。使用UTF-8编码的Unicode，长度为0~256字符（即Value可以为空），允许任何语言文字、数字、空格和_ . : / = + - @符号。每个角色至多附加50对标签。

返回参数

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

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

请求示例

GET /?Action=CreateRole&Version=2018-01-01&RoleName=ops-role&DisplayName=%E8%BF%90%E7%BB%B4%E8%A7%92%E8%89%B2&Description=%E8%BF%90%E7%BB%B4%E8%A7%92%E8%89%B2&TrustPolicyDocument=%7B%0A%20%20%20%20%22Statement%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%22Effect%22%3A%20%22Allow%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22Action%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22sts%3AAssumeRole%22%0A%20%20%20%20%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22Principal%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22Service%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22cloud_trail%22%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%5D%0A%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%7D&MaxSessionDuration=3600&Tags.1.Key=department&Tags.1.Value=ops HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20241121T065853Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241121/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240911180701247010254051B74B91",
    "Action": "CreateRole",
    "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"
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidRoleName	Invalid RoleName '%s', err: '%s'	角色名不合法。
400	InvalidTrustPolicyDoc	Invalid TrustPolicy, err: '%s'.	角色信任策略不合法。
409	RoleAlreadyExists	Role '%s' already exists.	角色已存在。
409	RoleNameAlreadyExists	NewRoleName %s already exists	角色名已存在。