StartConfigurationRecorder - Cloud Config - Alibaba Cloud Documentation Center

Operation description

The following describes the differences between calling this operation as a standard account and as a management account:

If you use a standard account, you can call this operation to enable the Cloud Config service for your account. You can then view the resources and manage the compliance rules for the account.
If you use a management account of a resource directory, you can enable the Cloud Config service for all member accounts by setting the EnterpriseEdition parameter to true when you call this operation. By default, a global account group is created that contains all member accounts. You can then view the resources and manage the compliance rules for all member accounts within this account group.

This topic provides an example of how to use a standard account to enable the Cloud Config service and monitor the resources of the current account.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnterpriseEdition	boolean	No	Specifies whether to upgrade to the Enterprise Edition of Cloud Config. Valid values: true false (default) Note The Enterprise Edition of Cloud Config is upgraded to account groups. For more information, see Notice: The Enterprise Edition of Cloud Config is upgraded to account groups.	false

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

Response elements

Parameter	Type	Description	Example
	object	None.
ConfigurationRecorder	object	The information about resource monitoring.
AccountId	integer	The ID of the Alibaba Cloud account. Note This parameter is returned only when a standard account calls this operation.	123456789
ConfigurationRecorderStatus	string	The status of resource monitoring. Valid values: REGISTRABLE: The resource monitoring is not enabled. BUILDING: The resource monitoring is being enabled. REGISTERED: The resource monitoring is enabled. REBUILDING: The resource monitoring is being re-enabled.	REGISTRABLE
OrganizationEnableStatus	string	The status of the upgrade to the Enterprise Edition of Cloud Config. Valid values: REGISTRABLE: The service is not upgraded. BUILDING: The service is being upgraded. REGISTERED: The service is upgraded.	REGISTRABLE
OrganizationMasterId	integer	The ID of the management account. Note This parameter is returned only when a management account calls this operation.	987654321
ResourceTypes	array	The list of resource types.
	string	The list of resource types. Note By default, Cloud Config returns all resource types. The example response shows only the `ACS::ECS::Instance` and `ACS::ECS::NetworkInterface` 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": 123456789,
    "ConfigurationRecorderStatus": "REGISTRABLE",
    "OrganizationEnableStatus": "REGISTRABLE",
    "OrganizationMasterId": 987654321,
    "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.
400	ProcessIsRunning	The process is running.	The process is running.
400	RDMemberNoPermission	You are not authorized to perform the operation. The reasons include: 1. You have not enabled the resource directory service. 2. You are not using the administrator account of resource directory.	You are not authorized to perform the operation. The reasons include: 1. You have not enabled the resource directory service. 2. You are not using the administrator account of resource directory.
500	CreateSLRFail	Failed to create SLR.	Failed to create SLR.
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 Error Codes for a complete list.

Release notes

See Release Notes for a complete list.