DocsICP FilingConsole
Documentation

GetControlPolicyEnablementStatus

Updated at:
Copy as MD
Product
My Favorites

Queries the enablement status of the control policy feature by calling GetControlPolicyEnablementStatus.

Operation description

Queries the current enablement or disablement status of the control policy feature. After the call, you can use the EnablementStatus response parameter to determine whether the control policy feature is enabled, being enabled, disabled, or being disabled.

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:GetControlPolicyEnablementStatus

get

*ResourceDirectory

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

 None None

Request parameters

Parameter

Type

Required

Description

Example
ControlPolicyType

string

No

The type of the control policy. Valid values:

  • CONTROL_POLICY: control policy.

  • RESOURCE_CONTROL_POLICY: resource control policy.

Default value: CONTROL_POLICY.

RESOURCE_CONTROL_POLICY

Response elements

Element

Type

Description

Example

object

The response parameters.

EnablementStatus

string

The status of the control policy feature. Valid values:

  • Enabled: The feature is enabled.

  • PendingEnable: The feature is being enabled.

  • Disabled: The feature is disabled.

  • PendingDisable: The feature is being disabled.

Disabled
RequestId

string

The request ID.

1DC39A4E-3B52-4EFE-9F93-4897D7FFA0C4
ControlPolicyType

string

The type of the control policy. Valid values:

  • CONTROL_POLICY: control policy.

  • RESOURCE_CONTROL_POLICY: resource control policy.

RESOURCE_CONTROL_POLICY

Examples

Success response

JSON format

{
  "EnablementStatus": "Disabled",
  "RequestId": "1DC39A4E-3B52-4EFE-9F93-4897D7FFA0C4",
  "ControlPolicyType": "RESOURCE_CONTROL_POLICY"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.