All Products
Search

This Product

    Resource Management:CreatePolicy

    Document Center

    Resource Management:CreatePolicy

    Last Updated:Jun 20, 2024

    Creates a tag policy.

    Operation description

    This topic provides an example on how to call the API operation to create a tag policy named test. In this example, the Tag Policy feature in multi-account mode is used. The tag policy defines that resources to which the CostCenter:Beijing or CostCenter:Shanghai tag is added are compliant and other resources are not compliant.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    tag:CreatePolicyWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID. Set the value to cn-shanghai.

    		cn-shanghai
    PolicyNamestringYes

    The name of the tag policy.

    The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (_).

    		test
    PolicyDescstringNo

    The description of the tag policy.

    The description must be 0 to 512 characters in length.

    		This is a tag policy example.
    PolicyContentstringYes

    The document of the tag policy.

    For more information about the syntax of a tag policy, see Syntax of a tag policy.

    		{"tags":{"CostCenter":{"tag_value":{"@@assign":["Beijing","Shanghai"]},"tag_key":{"@@assign":"CostCenter"}}}}
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • false (default): performs a dry run and performs the actual request.
    • true: performs only a dry run.
    		false
    UserTypestringNo

    The mode of the Tag Policy feature. Valid values:

    • USER: single-account mode. Set the value to USER if you use an Alibaba Cloud account or a member of a resource directory to call this API operation to create a tag policy for the Alibaba Cloud account or member.
    • RD: multi-account mode. Set the value to RD if you use the management account of a resource directory to call this API operation to create a tag policy for the resource directory.

    For more information about the modes of the Tag Policy feature, see Modes of the Tag Policy feature.

    		RD

    For more information about common request parameters, see Common parameters.

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned result.

    RequestIdstring

    The request ID.

    		FDBE270D-C491-5EEC-A5CD-98245422D3F7
    PolicyIdstring

    The ID of the tag policy.

    		p-5732750813924f90****
    PolicyNamestring

    The name of the tag policy.

    		test

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "FDBE270D-C491-5EEC-A5CD-98245422D3F7",
  "PolicyId": "p-5732750813924f90****",
  "PolicyName": "test"
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-12-08The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.