接口请求域名: cam.intl.tencentcloudapi.com 。
本接口(CreateRole)用于创建角色。
默认接口请求频率限制:2次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateRole。 |
| Version | 是 | String | 公共参数,本接口取值:2019-01-16。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| RoleName | 是 | String | 角色名称。长度为1~128个字符,可包含英文字母、数字和+=,.@-_。 |
| PolicyDocument | 是 | String | 策略文档,示例:{"version":"2.0","statement":[{"action":"name/sts:AssumeRole","effect":"allow","principal":{"service":["cloudaudit.cloud.tencent.com","cls.cloud.tencent.com"]}}]},principal用于指定角色的授权对象。获取该参数可参阅 获取角色详情(https://www.tencentcloud.com/document/product/598/36221?from_cn_redirect=1) 输出参数RoleInfo |
| Description | 否 | String | 角色描述 |
| ConsoleLogin | 否 | Integer | 是否允许登录 1 为允许 0 为不允许 |
| SessionDuration | 否 | Integer | 申请角色临时密钥的最长有效期限制(范围:0~43200) |
| Tags.N | 否 | Array of RoleTags | 角色绑定标签 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RoleId | String | 角色ID |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
以下示例将创建一个以日志服务和操作审计为载体的角色
https://cam.intl.tencentcloudapi.com/?Action=CreateRole
&RoleName=test_1234544
&PolicyDocument=%7B%22version%22%3A%222.0%22%2C%22statement%22%3A%5B%7B%22action%22%3A%22name%2Fsts%3AAssumeRole%22%2C%22effect%22%3A%22allow%22%2C%22principal%22%3A%7B%22service%22%3A%5B%22cloudaudit.cloud.tencent.com%22%2C%22cls.cloud.tencent.com%22%5D%7D%7D%5D%7D
&Description=adminRole remark
&<公共请求参数>
{
"Response": {
"RoleId": "123456789000",
"RequestId": "0bac591a-6cc7-4e9d-8d01-74618f1a9611"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.TagResourceFailed | 绑定标签失败。 |
| InternalError.SystemError | 内部错误。 |
| InvalidParameter.ActionError | 策略文档的Action字段不合法。 |
| InvalidParameter.ActionMiss | 策略语法中操作不存在。 |
| InvalidParameter.AttachmentFull | principal字段的授权对象关联策略数已达到上限。 |
| InvalidParameter.ConditionContentError | 策略语法中条件内容不正确。 |
| InvalidParameter.ConditionError | 策略文档的condition字段不合法。 |
| InvalidParameter.ConditionTypeError | 策略语法中条件操作符不正确。 |
| InvalidParameter.DescriptionLengthOverlimit | Description入参长度不能大于300字节。 |
| InvalidParameter.EffectError | 策略文档的Effect字段不合法。 |
| InvalidParameter.ParamError | 非法入参。 |
| InvalidParameter.PrincipalError | 策略文档的principal字段不合法。 |
| InvalidParameter.PrincipalQcsCrossError | 角色载体不允许跨站。 |
| InvalidParameter.PrincipalQcsError | PrincipalQcsc错误。 |
| InvalidParameter.PrincipalQcsNotExist | PrincipalQcs不存在。 |
| InvalidParameter.PrincipalServiceNotExist | PrincipalService不存在。 |
| InvalidParameter.RoleFull | 角色数量达到上限。 |
| InvalidParameter.RoleNameError | 角色名不合法。 |
| InvalidParameter.RoleNameInUse | 相同名称的角色已存在。 |
| InvalidParameter.StatementError | 策略文档的Statement字段不合法。 |
| InvalidParameter.TagLimitExceeded | 超出标签限制。 |
| InvalidParameter.TagParamError | 标签参数错误。 |
| InvalidParameter.UserNotExist | 用户对象不存在。 |
| InvalidParameter.VersionError | 策略文档的Version字段不合法。 |
文档反馈