Obtaining Monitoring System Configurations

Function

This API is used to obtain monitoring system configurations.

URI

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

**Table 1** Path parameter
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. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
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 more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1. Enumerated value: v1
kind	String	API type. Fixed value: MonitorSystem. Enumerated value: MonitorSystem
spec	ShowMonitorSystemResponseBodySpec object	Queried monitoring system configurations.

**Table 4** ShowMonitorSystemResponseBodySpec
Parameter	Type	Description
id	String	Monitoring system ID.
type	String	Collection mode. Enumerated value: apm2
instrumentation	String	Agent injection mode. Enumerated values: manual automatic
access_key	String	APM 2.0 access key.
access_value	String	APM 2.0 access key value.
access_token	String	APM 2.0 token.
master_address	String	Agent access point.
apm_application	String	APM 2.0 application.
version	String	Enhanced Agent version.
image_pull_policy	String	Agent image update policy. Enumerated values: Always IfNotPresent
created_at	String	Creation time.
updated_at	String	Update time.

Example Request

Obtain monitoring system configurations.

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

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "MonitorSystem",
  "spec" : {
    "id" : "monitorsystemID",
    "type" : "apm2",
    "instrumentation" : "automatic",
    "access_key" : "******",
    "access_value" : "******",
    "master_address" : "https://10*.*.*.*:443",
    "apm_application" : "default",
    "version" : "2.4.5.3-100sampling-x86_64",
    "image_pull_policy" : "Always",
    "created_at" : "2024-01-02T13:26:33.267626Z",
    "updated_at" : "2024-01-03T09:15:22.926128Z"
  }
}