Creating the Monitoring System Configuration

Function

This API is used to create the monitoring system configuration.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /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. 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 is 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. To obtain an environment ID, see Obtaining the Environment List. In the response, id under items indicates the 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	Definition Collection mode. Range opentelemetry: interconnect with OpenTelemetry agents. apm2: interconnect with APM 2.0 agents. Default Value N/A
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

Create the monitoring system configuration.

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

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