You need to enable JavaScript to run this app.
导航
访问控制
  • 文档首页
    • /访问控制/API参考/角色/UpdateRole - 更新角色
UpdateRole - 更新角色
最近更新时间：2024.11.21 21:18:32首次发布时间：2021.02.23 10:42:32
我的收藏

更新指定角色的信息。

调试

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

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

UpdateRole

要执行的操作，取值：UpdateRole。

Version
String
是

2018-01-01

API的版本，取值：2018-01-01。

RoleName
String
是

ops-role

角色名。

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"
                ]
            }
        }
    ]
}
NewRoleName
String
否

service-role

新角色名。

DisplayName
String
否

服务角色。

新显示名。

Description
String
否

服务角色。

新描述。

MaxSessionDuration
Integer
否

3600

角色最大会话时间。取值范围：3600秒~43200秒。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=UpdateRole&Version=2018-01-01&RoleName=ops-role&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&NewRoleName=service-role&DisplayName=%E6%9C%8D%E5%8A%A1%E8%A7%92%E8%89%B2%E3%80%82&Description=%E6%9C%8D%E5%8A%A1%E8%A7%92%E8%89%B2%E3%80%82&MaxSessionDuration=3600 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20241121T065812Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241121/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240913174843105055093184CDEB0C",
    "Action": "UpdateRole",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  }
}

错误码

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

状态码
错误码
错误信息
说明
400
InvalidRoleName
Invalid RoleName '%s', err: '%s'

角色名不合法。

400
InvalidTrustPolicyDoc
Invalid TrustPolicy, err: '%s'.

信任策略不合法。

404
RoleNotExist
Role '%s' cannot be found

角色不存在。

409
RoleNameAlreadyExists
NewRoleName %s already exists

角色名已存在。