Obtaining the Monitoring System Configuration
Function
Obtain the monitoring system configuration.
URI
GET /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.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
api_version |
String |
API version. Fixed value: v1. |
kind |
String |
API type. Fixed value: MonitorSystem. |
spec |
Queried monitoring system configurations. |
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.
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