DescribeConfigurationRecorder-阿里云帮助中心

Operation description

This topic provides an example of how to query the resource monitoring scope for the Alibaba Cloud account 100931896542****. The response shows that the monitored resource types are ACS::ECS::Instance and ACS::ECS::NetworkInterface, and the resource monitoring status is REGISTERED.

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

config:DescribeConfigurationRecorder

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

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

Response elements

Element	Type	Description	Example
	object	None.
ConfigurationRecorder	object	The information about resource monitoring.
AccountId	integer	The ID of the current Alibaba Cloud account.	100931896542****
ConfigurationRecorderStatus	string	The resource monitoring status. Valid values: REGISTRABLE: The resource monitoring feature is not enabled. BUILDING: The resource monitoring feature is being enabled. REGISTERED: The resource monitoring feature is enabled. REBUILDING: The resource monitoring feature is being re-enabled.	REGISTERED
OrganizationEnableStatus	string	The upgrade status of Cloud Config for an enterprise. Valid values: REGISTRABLE: Cloud Config is not upgraded for the enterprise. BUILDING: Cloud Config is being upgraded for the enterprise. REGISTERED: Cloud Config is upgraded for the enterprise.	REGISTRABLE
OrganizationMasterId	integer	The ID of the management account. Note This parameter is returned only when the API operation is called by a management account.	120886317861****
ResourceTypes	array	The list of resource types.
	string	The list of resource types.	["ACS::ECS::Instance","ACS::ECS::NetworkInterface"]
RequestId	string	The request ID.	A3601178-A6A2-4636-BE56-1116F73C0B0C

Examples

Success response

JSON format

{
  "ConfigurationRecorder": {
    "AccountId": 0,
    "ConfigurationRecorderStatus": "REGISTERED",
    "OrganizationEnableStatus": "REGISTRABLE",
    "OrganizationMasterId": 0,
    "ResourceTypes": [
      "[\"ACS::ECS::Instance\",\"ACS::ECS::NetworkInterface\"]"
    ]
  },
  "RequestId": "A3601178-A6A2-4636-BE56-1116F73C0B0C"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.

See for a complete list.

Release notes

See Release Notes for a complete list.