All Products
Search
Document Center

Managed Service for Prometheus:AppendInstancesToPrometheusGlobalView

Last Updated:May 09, 2024

Adds a data source to a global aggregation instance.

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 global aggregation instance.

zyGlobalView
ClustersstringYes

The list of 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":"Remote read endpoint of the MetricStore", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"Remote read endpoint of the self-managed Prometheus data source", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"Endpoint of another data source such as Tencent remote read", "headers":{ "AnyHeaderToFill":"Headers to be filled" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]
GlobalViewClusterIdstringYes

The ID of the global aggregation instance.

global-v2-cn-1670100631025794-6gjc0qgb

Response parameters

ParameterTypeDescriptionExample
object
Dataobject

The information about the array object.

Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
True
Msgstring

The additional information.

OK
Infostring

The Info-level information.

{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedInstances: the ID of the object that failed to be added.}
RequestIdstring

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

27E653FA-5958-45BE-8AA9-14D884DC****

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Success": true,
    "Msg": "OK",
    "Info": "{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedInstances: the ID of the object that failed to be added.}\n"
  },
  "RequestId": "27E653FA-5958-45BE-8AA9-14D884DC****"
}

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.