Querying the Resource Recorder

Function

This API is used to query details about the resource recorder.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
channel	ChannelConfigBody object	Specifies configurations for the tracker.
selector	SelectorConfigBody object	Specifies the selector.
retention_period_in_days	Integer	Specifies the number of days for data storage.
agency_name	String	Specifies the IAM agency name.
domain_id	String	Account ID
frozen_status	FrozenStatus object	the tracker frozen status

**Table 4** ChannelConfigBody
Parameter	Type	Description
smn	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	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	Type	Description
region_id	String	Specifies the region ID of the SMN topic.
project_id	String	Specifies the project ID of the user.
topic_urn	String	Specifies the SMN topic URN.

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

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

**Table 8** FrozenStatus
Parameter	Type	Description
is_frozen	Boolean	is frozen
frozen_scene	Array of strings	frozen scene

Status code: 400

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "agency_name" : "rms_tracker_agency",
  "channel" : {
    "obs" : {
      "bucket_name" : "rmtest",
      "region_id" : "regionid1",
      "bucket_prefix" : "log_dir"
    },
    "smn" : {
      "project_id" : "059b5e0a2500d5552fa1c00adada8c06",
      "region_id" : "regionid1",
      "topic_urn" : "urn:smn:regionid1:059b5e0a2500d5552fa1c00adada8c06:agencytest"
    }
  },
  "selector" : {
    "all_supported" : true,
    "resource_types" : [ ]
  },
  "retention_period_in_days" : 2557,
  "domain_id" : "string",
  "frozen_status" : null
}

Status Codes

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

Error Codes

See Error Codes.

Parent topic:Resource Recorder

Previous topic: Resource Recorder

Next topic: Deleting the Resource Recorder

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.