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

Updating the Monitoring System Configuration

Function

Update the monitoring system configuration.

URI

PUT /v1/{project_id}/cae/monitor-system/{monitor_system_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

monitor_system_id

Yes

String

Monitoring system configuration 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

No

String

API version. Fixed value: v1.

kind

No

String

API type. Fixed value: MonitorSystem.

spec

No

MonitorSystemRequestBodySpec object

Created or updated monitoring system configurations.

Table 4 MonitorSystemRequestBodySpec

Parameter

Mandatory

Type

Description

type

Yes

String

Collection mode.

instrumentation

Yes

String

Agent injection mode.

access_key

No

String

APM 2.0 access key.

access_value

No

String

APM 2.0 access key value.

access_token

No

String

APM 2.0 OpenTelemetry access token.

apm_application

Yes

String

APM 2.0 application.

version

Yes

String

Enhanced or OpenTelemetry probe version.

image_pull_policy

Yes

String

Agent image update policy.

Response Parameters

Status code: 204

Request succeeded.

None

Example Requests

Update the monitoring system configuration.

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

{
  "api_version" : "v1",
  "kind" : "MonitorSystem",
  "spec" : {
    "type" : "opentelemetry",
    "access_token" : "******",
    "apm_application" : "default",
    "image_pull_policy" : "Always",
    "version" : "1.32.0.14",
    "instrumentation" : "automatic"
  }
}

Example Responses

None

Status Codes

Status Code

Description

204

Request succeeded.

Error Codes

See Error Codes.