Help Center/ Config/ API Reference/ APIs/ Resource Recorder/ Creating or Modifying the Resource Recorder

Updated on 2025-03-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating or Modifying the Resource Recorder

Function

This API is used to create or modify the resource recorder. Only one resource recorder can be configured.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/resource-manager/domains/{domain_id}/tracker-config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies the account ID. Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Specifies the invoker's token.
X-Security-Token	No	String	Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
channel	Yes	ChannelConfigBody object	Specifies configurations for the tracker.
selector	Yes	SelectorConfigBody object	Specifies the selector.
retention_period_in_days	No	Integer	Specifies the number of days for data storage.
agency_name	Yes	String	Specifies the IAM agency name.

**Table 4** ChannelConfigBody
Parameter	Mandatory	Type	Description
smn	No	TrackerSMNChannelConfigBody object	Specifies SMN related configurations. For details about how to grant other accounts the permissions for publishing messages to SMN topics, see Cross-Account Authorization (Resource Recorder > Enabling, Configuring, or Modifying the Resource Recorder) in the User Guide.
obs	No	TrackerOBSChannelConfigBody object	Specifies OBS related configurations. For details about how to grant other accounts the permissions for dumping files to OBS buckets, see Cross-Account Authorization (Resource Recorder > Enabling, Configuring, or Modifying the Resource Recorder) in the User Guide.

**Table 5** TrackerSMNChannelConfigBody
Parameter	Mandatory	Type	Description
region_id	Yes	String	Specifies the region ID of the SMN topic.
project_id	Yes	String	Specifies the project ID of the user.
topic_urn	Yes	String	Specifies the SMN topic URN.

**Table 6** TrackerOBSChannelConfigBody
Parameter	Mandatory	Type	Description
bucket_name	Yes	String	Specifies the OBS bucket name. Maximum: 63
bucket_prefix	No	String	OBS bucket prefix Maximum: 256
region_id	Yes	String	Specifies the region ID.

**Table 7** SelectorConfigBody
Parameter	Mandatory	Type	Description
all_supported	Yes	Boolean	Specifies whether to select all supported resources.
resource_types	Yes	Array of strings	Specifies the resource type list.

Response Parameters

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Creating the resource recorder and enabling message pushing and dumping

PUT /v1/resource-manager/domains/{domain_id}/tracker-config

{
  "channel" : {
    "smn" : {
      "region_id" : "regionid1",
      "project_id" : "39c2af998c334ed6bcbb75b27318f7b5",
      "topic_urn" : "urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test"
    },
    "obs" : {
      "bucket_name" : "config-snapshot",
      "region_id" : "regionid1",
      "bucket_prefix" : "log_dir"
    }
  },
  "selector" : {
    "all_supported" : true,
    "resource_types" : [ ]
  },
  "agency_name" : "rms_tracker_agency",
  "retention_period_in_days" : 2557
}

Example Responses

None

Status Codes

Status Code	Description
200	Operation succeeded.
400	Invalid parameters.
403	Authentication failed or you do not have the operation permissions.
404	Resources not found.
500	Server error.