CreatePolicy

Updated at: 2025-04-03 03:14

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
OperationAccess levelResource typeCondition keyAssociated operation
tag:CreatePolicycreate
*Policy
acs:tag::{#accountId}:policy/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
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
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

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400NoPermission.RAMThe operator is not permission for the action in ram policy.The account is not supported.
403EffectivePolicy.ResourceGroupScope.TooLongThe resource group range of for effective policy is too long.The resource group range for a valid policy is too long.
403RDAcount.HasOpenedAs the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.The member account of the resource directory has a tag policy. You must disable the member account before you can activate the multi-account mode.

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2023-12-08The response structure of the API has changedView Change Details
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare