All Products
Search
Document Center

Resource Management:GetEffectivePolicy

Last Updated:Jun 26, 2023

Queries an effective tag policy.

Operation Description

If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the effective tag policy for the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the effective tag policy for the Root folder, a folder other than the Root folder, or a member in the resource directory. You can also use a member of a resource directory to call this API operation to query the effective tag policy for the member. For more information about the modes of the Tag Policy feature, see Modes of the Tag Policy feature.

An effective tag policy is obtained based on tag policy inheritance. For more information, see Inheritance of a tag policy and calculation of an effective tag policy.

This topic provides an example on how to call the API operation to query the effective tag policy for the current logon account. In this example, the Tag Policy feature in single-account mode is used.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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

cn-shanghai
TargetIdstringNo

The ID of the object.

NoteIf you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this feature is required.
154950938137****
TargetTypestringNo

The type of the object. Valid values:

  • USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.
  • ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
  • FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
  • ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
NoteIf you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this feature is required. The value of this parameter is not case-sensitive.
ACCOUNT

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

BB532282-94F5-5F56-877F-32D5E2A04F3F
EffectivePolicystring

The effective tag policy.

{\"tags\":{\"costcenter\":{\"tag_value\":[\"Beijing\",\"Shanghai\"],\"tag_key\":\"CostCenter\"}}}

Examples

Sample success responses

JSONformat

{
  "RequestId": "BB532282-94F5-5F56-877F-32D5E2A04F3F",
  "EffectivePolicy": "{\\\"tags\\\":{\\\"costcenter\\\":{\\\"tag_value\\\":[\\\"Beijing\\\",\\\"Shanghai\\\"],\\\"tag_key\\\":\\\"CostCenter\\\"}}}"
}

Error codes

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