DescribeEnvServiceMonitor - Managed Service for Prometheus

Queries the ServiceMonitor details of an environment.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
EnvironmentId	string	Yes	The ID of the environment instance.	env-xxxxx
Namespace	string	Yes	The namespace where the ServiceMonitor is located.	arms-prom
ServiceMonitorName	string	Yes	The name of the ServiceMonitor.	arms-admin1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	40B10E04-81E8-4643-970D-F1B38F2E****
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.	200
Data	object	The returned struct.
EnvironmentId	string	The ID of the environment instance.	env-xxxxx
Namespace	string	The namespace.	arms-prom
RegionId	string	The region ID.	cn-hangzhou
ServiceMonitorName	string	The name of the ServiceMonitor.	serviceMonitor1
ConfigYaml	string	The YAML configuration string of the ServiceMonitor.	Refer to supplementary instructions.
Status	string	The status of the ServiceMonitor. Valid values: run and stop.	run
Message	string	The returned message.	success

Examples

Sample success responses

JSONformat

{
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "Namespace": "arms-prom",
    "RegionId": "cn-hangzhou",
    "ServiceMonitorName": "serviceMonitor1",
    "ConfigYaml": "Refer to supplementary instructions.",
    "Status": "run"
  },
  "Message": "success"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history