1. 接口描述
接口请求域名: organization.tencentcloudapi.com 。
创建权限配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateRoleConfiguration。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 空间 ID。 示例值:z-232ns223s |
RoleConfigurationName | 是 | String | 权限配置名称。格式:包含英文字母、数字或短划线(-)。 长度:最大 128 个字符。 示例值:test |
Description | 否 | String | 权限配置的描述。 长度:最大 1024 个字符。 示例值:this is role configuration |
SessionDuration | 否 | Integer | 会话持续时间。 CIC用户使用权限配置访问集团账号目标账号时,会话最多保持的时间。 单位:秒。 取值范围:900 ~ 43200(15 分钟~12 小时)。 默认值:3600(1 小时)。 示例值:900 |
RelayState | 否 | String | 初始访问页面。 CIC用户使用权限配置访问集团账号目标账号时,初始访问的页面地址。 该页面必须是腾讯云控制台页面。默认为空,表示跳转到腾讯云控制台首页。 示例值:https://console.cloud.tencent.com |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RoleConfigurationInfo | RoleConfiguration | 配置访问详情 示例值:{"RoleConfigurationId":"rc-s2ns92ns***","RoleConfigurationName":"test","Description":"this is role configuration","SessionDuration":900,"RelayState":"https://console.cloud.tencent.com","CreateTime":"2019-01-01 12:12:12","UpdateTime":"2019-01-01 12:12:12"} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建权限配置
创建权限配置
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRoleConfiguration
<公共请求参数>
{
"ZoneId": "z-33923n",
"RoleConfigurationName": "test",
"Description": "this is role configuration",
"SessionDuration": 900,
"RelayState": "https://console.cloud.tencent.com"
}
输出示例
{
"Response": {
"RoleConfigurationInfo": {
"RoleConfigurationId": "rc-s2ns92ns***",
"RoleConfigurationName": "test",
"Description": "this is role configuration",
"SessionDuration": 900,
"RelayState": "https://console.cloud.tencent.com",
"CreateTime": "2019-01-01 12:12:12",
"UpdateTime": "2019-01-01 12:12:12"
},
"RequestId": "e297543a-80de-4039-83c8-9d324545"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ConfigurationOverUpperLimit | 一个目录的权限配置创建超过上限 |
FailedOperation.DBOperationError | SQL执行报错 |
FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
InvalidParameter.ConfigurationNameAlreadyExists | 权限配置名称已经存在 |
InvalidParameter.ConfigurationNameFormatError | 权限配置名称格式错误 |