1. 接口描述
接口请求域名: organization.tencentcloudapi.com 。
为权限配置添加策略
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddPermissionPolicyToRoleConfiguration。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 空间 ID 示例值:z-29n23ien |
RoleConfigurationId | 是 | String | 权限配置 ID 示例值:rc-so2msow |
RolePolicyType | 是 | String | 权限策略类型。取值: System:系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。 示例值:System |
RolePolicyNames.N | 否 | Array of String | 权限策略名称,长度最大为 20策略,每个策略长度最大32个字符。如果要添加系统策略,建议使用RolePolicies参数。自定义策略时,数组长度最大为1。 示例值:["TestPolicy","Admin"] |
RolePolicies.N | 否 | Array of PolicyDetail | 添加的系统策略详情。 示例值:[{'PolicyId':426322, 'PolicyName':'QcloudAccessForOceanusRole'}] |
CustomPolicyDocument | 否 | String | 自定义策略内容。长度:最大 4096 个字符。当RolePolicyType为Inline时,该参数必须配置。关于权限策略的语法和结构,请参见权限策略语法和结构。 示例值:{"statement":{"action":["name/cvm:","name/vpc:","name/cos:","name/cmqtopic:","name/cmqqueue:"],"effect":"allow","resource":""},"version":"2.0"} |
CustomPolicyDocuments.N | 否 | Array of String | 自定义策略内容列表(跟RolePolicyNames一一对应) 示例值:[ "policyContent1", "policyContent2" ] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 为权限配置添加策略
为权限配置添加策略
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddPermissionPolicyToRoleConfiguration
<公共请求参数>
{
"ZoneId": "z-29wm2iwn",
"RoleConfigurationId": "rc-aiwmsiw",
"RolePolicyType": "System",
"RolePolicyNames": [
"TestPolicy"
],
"CustomPolicyDocument": "{\"statement\":{\"action\":[\"name/cvm:*\",\"name/vpc:*\",\"name/cos:*\",\"name/cmqtopic:*\",\"name/cmqqueue:*\"],\"effect\":\"allow\",\"resource\":\"*\"},\"version\":\"2.0\"}"
}
输出示例
{
"Response": {
"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.CustomPolicyOverUpperLimit | 权限配置绑定自定义策略超过上限 |
FailedOperation.DBOperationError | SQL执行报错 |
FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
FailedOperation.SystemPolicyOverUpperLimit | 权限配置绑定系统策略超过上限 |
FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
InvalidParameter.BindPolicyNameNotAllowed | 权限配置不允许绑定该策略。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.PolicyDocumentEmpty | 自定义策略内容不能为空 |
InvalidParameter.PolicyNameAlreadyExists | 策略名称已经存在 |
InvalidParameter.PolicyNameSizeOverUpperLimit | 策略名称长度超限。 |
InvalidParameter.RoleConfigurationNotExist | 权限配置不存在 |