Last updated: 2021-04-20 11:21:22

    1. API Description

    Domain name for API request:

    This API is used to add a policy version. After creating a policy version, you can easily change the policy by changing the policy version.

    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.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: CreatePolicyVersion.
    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 Yes Integer Policy ID
    PolicyDocument Yes String The policy document to use as the content for the new version
    SetAsDefault Yes Boolean Specifies whether to set this version as the default version

    3. Output Parameters

    Parameter Name Type Description
    VersionId Integer Policy version ID
    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 Creating policy version

    This example shows you how to create a policy version.

    Input Example

    POST / HTTP/1.1
    Content-Type: application/json
    X-TC-Action: CreatePolicyVersion
    <Common request parameters>
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":[\"name/cos:*\"],\"resource\":[\"*\"]}]}",
        "SetAsDefault": true,
        "PolicyId": 1

    Output Example

      "Response": {
        "VersionId": "4",
        "RequestId": "60e60a86-af67-4bbe-8377-7024a0e1d4c7"

    5. Developer Resources


    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.PolicyFull The number of user policies has exceeded the limit.
    FailedOperation.PolicyNameInUse The policy name specified by the PolicyName field already exists.
    FailedOperation.PolicyVersionFull The number of policy versions has reached the upper limit.
    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.PolicyIdNotExist Policy ID does not exist.
    InvalidParameter.PolicyNameError PolicyName field invalid.
    InvalidParameter.PrincipalError principal field of policy document invalid.
    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.UserNotExist User does not exist.