tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
문서

UpdatePolicy

마지막 업데이트 시간:2022-03-14 17:37:09

1. API Description

Domain name for API request: cam.tencentcloudapi.com.

This API is used to update a policy.
This API will update the default version of an existing policy instead of creating a new one. If no policy exists, a default version will be created.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: UpdatePolicy.
Version Yes String Common parameter. The value used for this API: 2019-01-16.
Region No String Common parameter. This parameter is not required for this API.
PolicyId No Integer Policy ID. Either PolicyId or PolicyName must be entered
PolicyName No String Policy name. Either PolicyName or PolicyId must be entered
Description No String Policy description
PolicyDocument No String Policy documentation, for example: {"version":"2.0","statement":[{"action":"name/sts:AssumeRole","effect":"allow","principal":{"service":["cloudaudit.cloud.tencent.com","cls.cloud.tencent.com"]}}]}, where principal is used to specify the service that is authorized to use the role. For more information about this parameter, see RoleInfo under Output Parameters in the GetRole.
Alias No String Preset policy remark

3. Output Parameters

Parameter Name Type Description
PolicyId Integer Policy ID, which will be returned only if the input parameter is PolicyName
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Updating a policy

This example shows you how to update a policy to allow the user to access any COS resources with any COS API.

Input Example

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
&<Common request parameters>

Output Example

{
  "Response": {
    "PolicyId": 1,
    "RequestId": "60e60a86-af67-4bbe-8377-7024a0e1d4c7"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.PolicyNameInUse The policy name specified by the PolicyName field already exists.
InternalError.SystemError Internal error.
InvalidParameter.ActionError Action field of policy document invalid.
InvalidParameter.ActionMiss The action in the policy syntax does not exist.
InvalidParameter.ActionNotExist The action in the policy syntax does not exist.
InvalidParameter.ActionServiceNotExist The action service in the policy syntax does not exist.
InvalidParameter.AttachmentFull Limit on number of authorization object associated policies in the principal field reached.
InvalidParameter.ConditionContentError The condition content in the policy syntax is incorrect.
InvalidParameter.ConditionError condition field of policy document invalid.
InvalidParameter.ConditionTypeError The condition operator in the policy syntax is incorrect.
InvalidParameter.DescriptionLengthOverlimit The input parameter description cannot exceed 300 bytes in length.
InvalidParameter.EffectError Effect field of policy document invalid.
InvalidParameter.NotSupportProduct CAM does not support the resource type specified in the policy document.
InvalidParameter.ParamError Invalid input parameter.
InvalidParameter.PolicyDocumentError PolicyDocument field invalid.
InvalidParameter.PolicyDocumentLengthOverLimit PolicyDocument field exceeds length restriction.
InvalidParameter.PolicyIdError Input parameter PolicyId invalid.
InvalidParameter.PolicyIdNotExist Policy ID does not exist.
InvalidParameter.PolicyNameError PolicyName field invalid.
InvalidParameter.PrincipalError principal field of policy document invalid.
InvalidParameter.PrincipalQcsError Incorrect PrincipalQcsc.
InvalidParameter.PrincipalQcsNotExist PrincipalQcs does not exist.
InvalidParameter.PrincipalServiceNotExist PrincipalService does not exist.
InvalidParameter.ResourceContentError The resource context in the policy syntax is incorrect.
InvalidParameter.ResourceError Resource field of policy document invalid.
InvalidParameter.ResourceProjectError The resource project in the policy syntax is incorrect.
InvalidParameter.ResourceQcsError Incorrect resource QCS.
InvalidParameter.ResourceRegionError The resource region in the policy syntax is incorrect.
InvalidParameter.ResourceServiceNotExist The resource service in the policy syntax does not exist.
InvalidParameter.ResourceUinError The resource root account in the policy syntax is incorrect.
InvalidParameter.StatementError Statement field of policy document invalid.
InvalidParameter.UserNotExist User object does not exist
InvalidParameter.VersionError Version field of policy document invalid.
ResourceNotFound.GroupNotExist User group does not exist.
ResourceNotFound.NotFound Resource does not exist.
ResourceNotFound.PolicyIdNotFound Resources specified by PolicyId does not exist.
ResourceNotFound.UserNotExist User does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
개인정보 처리방침서비스 약관쿠키 정책