All Products
Search
Document Center

Managed Service for Prometheus:AddPrometheusGlobalView

Last Updated:May 09, 2024

Adds a global aggregation instance in Prometheus Service.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
GroupNamestringYes

The name of the aggregation instance.

zyGlobalView
ClustersstringYes

The queried global aggregation instances. The value is a JSON string.

[ { "sourceName": "Data source name- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId", }, { "sourceName": "Data source name - MetrcStore No.2", "sourceType":"MetricStore", "dataSource":"MetricStore remote read address", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"Build your own Prometheus data source remoteread address", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"Other data sources such as Tencent remoteread address", "headers":{ "AnyHeaderToFill":"Headers to be populated" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]
ResourceGroupIdstringNo

The resource group ID.

rg-aek2eq4pecazwfy
Tagobject []No

The list of tags.

KeystringNo

The tag key.

http.status_code
ValuestringNo

The tag value.

200

Response parameters

ParameterTypeDescriptionExample
object
Dataobject

The information about the array object.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Msgstring

The additional information.

OK
Infoobject

The Info-level information.

RegionIdstring

The region ID.

cn-hangzhou
GlobalViewClusterIdstring

The ID of the global aggregation instance.

global-v2-cn-1483223059272121-jmjjfznz
FailedInstancesstring

The list of instances that failed to be added.

\[{"sourceName": "Data source name- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]
RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

34ED024E-9E31-434A-9E4E-D9D15C3****

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Success": true,
    "Msg": "OK",
    "Info": {
      "RegionId": "cn-hangzhou",
      "GlobalViewClusterId": "global-v2-cn-1483223059272121-jmjjfznz",
      "FailedInstances": "\\[{\"sourceName\": \"Data source name- ArmsPrometheus\",\"sourceType\":\"AlibabaPrometheus\",\"userId\":\"UserID\",\"clusterId\":\"ClusterId\",}]\n"
    }
  },
  "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "Code": 200,
  "Message": "success"
}

Error codes

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

Change history

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