All Products
Search

This Product

    Resource Management:GetControlPolicy

    Document Center

    Resource Management:GetControlPolicy

    Last Updated:Apr 01, 2026

    Gets the details of a control policy.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    resourcemanager:GetControlPolicy

    get

    *ControlPolicy

    acs:resourcemanager::{#accountId}:policy/controlpolicy/{#PolicyId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PolicyId

    string

    Yes

    The ID of the control policy.

    cp-SImPt8GCEwiq****
    Language

    string

    No

    The language of the returned control policy description. Valid values:

    • zh-CN (default): Chinese.

    • en: English.

    • ja: Japanese.

    Note

    This parameter is valid only for system control policies.

    zh-CN

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned data.

    ControlPolicy

    object

    The details of the control policy.

    PolicyDocument

    string

    The content of the control policy.

    {\"Version\":\"1\",\"Statement\":[{\"Effect\":\"Deny\",\"Action\":[\"ram:UpdateRole\",\"ram:DeleteRole\",\"ram:AttachPolicyToRole\",\"ram:DetachPolicyFromRole\"],\"Resource\":\"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole\"}]}
    UpdateDate

    string

    The time the control policy was last updated.

    2021-03-18T08:51:33Z
    Description

    string

    The description of the control policy.

    ExampleControlPolicy
    EffectScope

    string

    The effective scope of the control policy. Valid values:

    • All: The control policy applies to Alibaba Cloud accounts, RAM users, and RAM roles.

    • RAM: The control policy applies only to RAM users and RAM roles.

    RAM
    AttachmentCount

    string

    The number of attachments.

    0
    PolicyName

    string

    The name of the control policy.

    test
    PolicyId

    string

    The ID of the control policy.

    cp-SImPt8GCEwiq****
    CreateDate

    string

    The time the control policy was created.

    2021-03-18T08:51:33Z
    PolicyType

    string

    The type of the control policy. Valid values:

    • System: A system-provided control policy.

    • Custom: A user-created control policy.

    Custom
    ControlPolicyType

    string

    RESOURCE_CONTROL_POLICY
    RequestId

    string

    The ID of the request.

    AB769936-CDFA-4D52-8CE2-A3581800044A

    Examples

    Success response

    JSON format

    {
  "ControlPolicy": {
    "PolicyDocument": "{\\\"Version\\\":\\\"1\\\",\\\"Statement\\\":[{\\\"Effect\\\":\\\"Deny\\\",\\\"Action\\\":[\\\"ram:UpdateRole\\\",\\\"ram:DeleteRole\\\",\\\"ram:AttachPolicyToRole\\\",\\\"ram:DetachPolicyFromRole\\\"],\\\"Resource\\\":\\\"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole\\\"}]}",
    "UpdateDate": "2021-03-18T08:51:33Z",
    "Description": "ExampleControlPolicy",
    "EffectScope": "RAM",
    "AttachmentCount": "0",
    "PolicyName": "test",
    "PolicyId": "cp-SImPt8GCEwiq****",
    "CreateDate": "2021-03-18T08:51:33Z",
    "PolicyType": "Custom",
    "ControlPolicyType": "RESOURCE_CONTROL_POLICY"
  },
  "RequestId": "AB769936-CDFA-4D52-8CE2-A3581800044A"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    404 EntityNotExists.ResourceControlPolicy The specified resource control policy does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.