Updated on 2024-06-19 GMT+08:00

Querying the Resources Involved in the Traces

Function

This API is used to query the resources involved in the traces.

URI

GET /v3/{domain_id}/resources

Table 1 Path parameter

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID. For details, see Obtaining an Account ID and Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

resources

Array of TraceResource objects

Returned resource list.

Table 3 TraceResource

Parameter

Type

Description

service_type

String

Cloud service type. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters.

resource

Array of strings

Resources corresponding to the cloud services.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 503

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Example Request

GET https://{endpoint}/v3/{domain_id}/resources

Example Response

Status code: 200

The request is successfully sent.

{
  "resources" : [ {
    "service_type" : "CTS",
    "resource" : [ "trace", "notification", "tracker" ]
  }, {
    "service_type" : "AOM",
    "resource" : [ "xxxx1", "xxxx2" ]
  } ]
}

Status Codes

Status Code

Description

200

The request is successfully sent.

400

The server failed to process the request.

401

The request is rejected due to authentication failure.

403

The server understood the request but refused to authorize it.

404

The requested resource does not exist.

500

Failed to complete the request because of an internal service error.

503

The requested service is invalid. The client should not repeat the request without modifications.

Error Codes

For details, see Error Codes.