All Products
Search
Document Center

Managed Service for Prometheus:GetPrometheusMonitoring

Last Updated:May 09, 2024

Queries the monitoring configuration of a Prometheus instance.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetPrometheusMonitoringRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The ID of the Prometheus instance.

cc7a37ee31aea4ed1a059eff8034b****
TypestringYes

The type of the monitoring configuration. Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. Valid values for a Prometheus instance for ECS: customJob and probe.

customJob
MonitoringNamestringYes

The name of the monitoring configuration.

customJob1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

78901766-3806-4E96-8E47-CFEF59E4****
Codeinteger

The status code. The status code 200 indicates that the request was successful.

200
Dataobject

The returned struct.

ClusterIdstring

Prometheus Instance ID.

c589a1b8db05c4561aefbb898ca8fb1cf
MonitoringNamestring

The name of the monitoring configuration.

customJob1
Typestring

The type of the monitoring configuration. Valid values: serviceMonitor, podMonitor, customJob, and probe.

serviceMonitor
Statusstring

The status of the monitoring configuration. Valid values: run and stop.

run
ConfigYamlstring

The monitoring configuration. The value is a YAML string.

Messagestring

The returned message.

message

Examples

Sample success responses

JSONformat

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Data": {
    "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
    "MonitoringName": "customJob1",
    "Type": "serviceMonitor",
    "Status": "run",
    "ConfigYaml": ""
  },
  "Message": "message"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-05-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.