All Products
Search
Document Center

Cloud Config:GetConfigurationRecorder

Last Updated:Jun 17, 2024

Queries the activation status and resource monitoring scope of Cloud Config for the current account.

Operation description

This topic provides an example on how to query the activation status and resource monitoring scope of Cloud Config for the current account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
config:GetConfigurationRecorderRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

AE43696A-B3AF-5E55-9845-11393127E6D3
ConfigurationRecorderobject

The details of the configuration recorder that monitors resources.

ConfigurationRecorderStatusstring

The status of the configuration recorder. Valid values:

  • REGISTRABLE: The configuration recorder has not been registered.
  • BUILDING: The configuration recorder is being deployed.
  • REGISTERED: The configuration recorder has been registered.
  • REBUILDING: The configuration recorder is being redeployed.
REGISTERED
ResourceTypesarray

The types of resources that are monitored.

string

The resource type.

ACS::ECS::Instance

Examples

Sample success responses

JSONformat

{
  "RequestId": "AE43696A-B3AF-5E55-9845-11393127E6D3",
  "ConfigurationRecorder": {
    "ConfigurationRecorderStatus": "REGISTERED",
    "ResourceTypes": [
      "ACS::ECS::Instance"
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

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

Change history

Change timeSummary of changesOperation
No change history