1. 接口描述
接口请求域名: cam.tencentcloudapi.com 。
本接口(UpdatePolicy )可用于更新策略。
如果已存在策略版本,本接口会直接更新策略的默认版本,不会创建新版本,如果不存在任何策略版本,则直接创建一个默认版本。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdatePolicy。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-16。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
PolicyId | 否 | Integer | 策略ID,与PolicyName二选一必填 示例值:17698703 |
PolicyName | 否 | String | 策略名,与PolicyId二选一必填 示例值:QCS_PolicyName |
Description | 否 | String | 策略描述 示例值:Policy_Description |
PolicyDocument | 否 | String | 策略文档 示例值:{"version":"2.0","statement":[{"effect":"allow","action":"cvm:Describe*","resource":"*"}]} |
Alias | 否 | String | 预设策略备注 示例值:remark |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PolicyId | Integer | 策略id,入参是PolicyName时,才会返回 注意:此字段可能返回 null,表示取不到有效值。 示例值:10041 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新一个策略
本示例将更新一个策略为允许用户以任何cos的API访问任何cos的资源
输入示例
https://cam.tencentcloudapi.com/?Action=UpdatePolicy
&PolicyId=17698703
&PolicyDocument=%7B%22version%22%3A%222.0%22%2C%22statement%22%3A%5B%7B%22effect%22%3A%22allow%22%2C%22action%22%3A%5B%22name%2Fcos%3A%2A%22%5D%2C%22resource%22%3A%5B%22%2A%22%5D%7D%5D%7D
&<公共请求参数>
输出示例
{
"Response": {
"PolicyId": 1,
"RequestId": "60e60a86-af67-4bbe-8377-7024a0e1d4c7"
}
}
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.OrganizationPolicyOperateError | 集团策略不允许操作。 |
FailedOperation.PolicyNameInUse | PolicyName字段指定的策略名已存在。 |
InternalError.SystemError | 内部错误。 |
InvalidParameter.ActionError | 策略文档的Action字段不合法。 |
InvalidParameter.ActionMiss | 策略语法中操作不存在。 |
InvalidParameter.ActionNotExist | 策略语法中操作不存在。 |
InvalidParameter.ActionServiceNotExist | 策略语法中操作服务不存在。 |
InvalidParameter.AttachmentFull | principal字段的授权对象关联策略数已达到上限。 |
InvalidParameter.ConditionContentError | 策略语法中条件内容不正确。 |
InvalidParameter.ConditionError | 策略文档的condition字段不合法。 |
InvalidParameter.ConditionTypeError | 策略语法中条件操作符不正确。 |
InvalidParameter.DescriptionLengthOverlimit | Description入参长度不能大于300字节。 |
InvalidParameter.EffectError | 策略文档的Effect字段不合法。 |
InvalidParameter.NotSupportProduct | CAM不支持策略文档中所指定的资源类型。 |
InvalidParameter.ParamError | 非法入参。 |
InvalidParameter.PolicyDocumentError | PolicyDocument字段不合法。 |
InvalidParameter.PolicyDocumentLengthOverLimit | PolicyDocument字段超过长度限制。 |
InvalidParameter.PolicyIdError | 输入参数PolicyId不合法。 |
InvalidParameter.PolicyIdNotExist | 策略ID不存在。 |
InvalidParameter.PolicyNameError | PolicyName字段不合法。 |
InvalidParameter.PrincipalError | 策略文档的principal字段不合法。 |
InvalidParameter.PrincipalQcsError | PrincipalQcsc错误。 |
InvalidParameter.PrincipalQcsNotExist | PrincipalQcs不存在。 |
InvalidParameter.PrincipalServiceNotExist | PrincipalService不存在。 |
InvalidParameter.ResourceContentError | 策略语法中资源内容不正确。 |
InvalidParameter.ResourceError | 策略文档的Resource字段不合法。 |
InvalidParameter.ResourceProjectError | 策略语法中资源项目不正确。 |
InvalidParameter.ResourceQcsError | 资源QCS错误。 |
InvalidParameter.ResourceRegionError | 策略语法中资源地域不正确。 |
InvalidParameter.ResourceServiceNotExist | 策略语法中资源服务不存在。 |
InvalidParameter.ResourceUinError | 策略语法中资源所属主账号不正确。 |
InvalidParameter.StatementError | 策略文档的Statement字段不合法。 |
InvalidParameter.UserNotExist | 用户对象不存在。 |
InvalidParameter.VersionError | 策略文档的Version字段不合法。 |
ResourceNotFound.GroupNotExist | 用户组不存在。 |
ResourceNotFound.NotFound | 资源不存在。 |
ResourceNotFound.PolicyIdNotFound | PolicyId指定的资源不存在。 |
ResourceNotFound.UserNotExist | 用户不存在。 |