Creating the Monitoring System Configuration
Function
This API is used to create the monitoring system configuration.
URI
POST /v1/{project_id}/cae/monitor-system
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. See Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token.
|
|
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
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.
|
|
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. |
|
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
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"
}
}
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot