调用StartConfigurationRecorder设置资源监控范围-配置审计-阿里云

接口说明

使用普通账号或企业管理账号调用该接口的差异如下：

如果您是普通账号，可以调用该接口为当前账号开启配置审计服务。您可以查看当前账号的资源，并管理当前账号的合规规则。
如果您是资源目录的企业管理账号，在调用该接口时将参数EnterpriseEdition设置为true，可以为所有成员账号开启配置审计服务，且默认创建一个包含所有成员账号的全局账号组。您可以在账号组中查看所有成员账号的资源，并管理所有成员账号的合规规则。

本文将提供一个示例，使用普通账号开启配置审计服务并监控当前账号的资源。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:StartConfigurationRecorder

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EnterpriseEdition	boolean	否	是否升级企业版配置审计。取值： true false（默认值）说明企业版配置审计升级为账号组。更多信息，请参见公告：企业版配置审计升级为账号组。	false

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	无。
ConfigurationRecorder	object	资源监控信息。
AccountId	integer	阿里云账号 ID。说明仅当普通账号调用该接口时，返回该参数。	120886317861****
ConfigurationRecorderStatus	string	资源监控状态。取值： REGISTRABLE：未注册。 BUILDING：构建中。 REGISTERED：已注册。 REBUILDING：重新构建中。	REGISTRABLE
OrganizationEnableStatus	string	企业版配置审计升级状态。取值： REGISTRABLE：未升级。 BUILDING：升级中。 REGISTERED：已升级。	REGISTRABLE
OrganizationMasterId	integer	企业管理账号 ID。说明仅当企业管理账号调用该接口时，返回该参数。	100931896542****
ResourceTypes	array	资源类型列表。
	string	资源类型列表。说明配置审计默认返回全部资源类型，返回示例仅以资源类型`ACS::ECS::Instance`和`ACS::ECS::NetworkInterface`为例进行展示。	["ACS::ECS::Instance","ACS::ECS::NetworkInterface"]
RequestId	string	请求 ID。	A3601178-A6A2-4636-BE56-1116F73C0B0C

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	You are not authorized to perform this operation.	您无权执行此操作。
400	ProcessIsRunning	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.	您无权进行此操作，原因可能是： 1、您未启用资源目录服务。 2、您使用的不是资源目录的企业管理账号。
500	CreateSLRFail	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.	服务不可用。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。