Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Monitoring system./ Obtaining the Monitoring System Configuration
Updated on 2025-10-22 GMT+08:00

Obtaining the Monitoring System Configuration

Function

Obtain the monitoring system configuration.

URI

GET /v1/{project_id}/cae/monitor-system

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.

NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

kind

String

API type. Fixed value: MonitorSystem.

spec

ShowMonitorSystemResponseBodySpec object

Queried monitoring system configurations.

Table 4 ShowMonitorSystemResponseBodySpec

Parameter

Type

Description

id

String

Monitoring system ID.

type

String

Collection mode.

instrumentation

String

Agent injection mode.

access_key

String

APM 2.0 access key.

access_value

String

APM 2.0 access key value.

access_token

String

APM 2.0 OpenTelemetry access token.

master_address

String

Agent access point.

apm_application

String

APM 2.0 application.

version

String

Enhanced or OpenTelemetry probe version.

image_pull_policy

String

Agent image update policy.

created_at

String

Creation time.

updated_at

String

Update time.

Example Requests

Obtain the monitoring system configuration.

GET https://{endpoint}/v1/{project_id}/cae/monitor-system

Example Responses

Status code: 200

OK

{
  "api_version" : "v1",
  "kind" : "MonitorSystem",
  "spec" : {
    "id" : "3ae303c7-10e2-497f-8e2c-79b47a******",
    "type" : "opentelemetry",
    "instrumentation" : "automatic",
    "access_token" : "******",
    "apm_application" : "test",
    "version" : "1.32.0.14",
    "image_pull_policy" : "Always",
    "created_at" : "2023-12-08T13:16:39.606846Z",
    "updated_at" : "2023-12-10T12:01:12.367968Z"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.