All Products
Search
Document Center

Application Real-Time Monitoring Service:GetManagedPrometheusStatus

Last Updated:Mar 01, 2024

Queries the installation status of a Prometheus agent in a serverless Kubernetes (ASK) cluster or an Elastic Compute Service (ECS) cluster.

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:GetManagedPrometheusStatusRead
  • Prometheus
    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The ID of the ASK cluster. This parameter is required if the ClusterType parameter is set to ask.

cc7a37ee31aea4ed1a059eff8034b****
ResourceGroupIdstringNo

The ID of the resource group to which the Prometheus instance belongs.

rg-acfmxyexli2****
ClusterTypestringYes

The type of the monitoring object. Valid values: ask , acs , one and ecs.

ask
VpcIdstringNo

This parameter is required if the ClusterType parameter is set to ecs.

vpc-***

Response parameters

ParameterTypeDescriptionExample
object

The response format.

RequestIdstring

The request ID.

F7781D4A-2818-41E7-B7BB-79D809E9****
Datastring

The status of the Prometheus instance.

  • Installing: The Prometheus instance is created and the Prometheus agent has no registration information.
  • Succeed: The Prometheus instance is created and the Prometheus agent is registered.
  • Failure: The Prometheus instance failed to be created or the Prometheus agent failed to be registered.
  • Unknown: No status of the Prometheus instance is available.
Installing
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Messagestring

The returned message.

Successful
Codeinteger

The status code or error code.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "F7781D4A-2818-41E7-B7BB-79D809E9****",
  "Data": "Installing",
  "Success": true,
  "Message": "Successful\n",
  "Code": 200
}

Error codes

HTTP status codeError codeError message
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

Change history

Change timeSummary of changesOperation
2023-11-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-05-15API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
2022-11-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2022-11-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400