AddPrometheusGlobalView - Application Real-Time Monitoring Service

Adds a global aggregation instance in Prometheus Service.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
arms:AddPrometheusGlobalView	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
GroupName	string	Yes	The name of the aggregation instance.	zyGlobalView
Clusters	string	Yes	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 ]
ResourceGroupId	string	No	The resource group ID.	rg-aek2eq4pecazwfy
Tag	array<object>	No	The list of tags.
	object	No	The tag that you want to add.
Key	string	No	The tag key.	http.status_code
Value	string	No	The tag value.	200

Response parameters

Parameter	Type	Description	Example
	object
Data	object	The information about the array object.
Success	boolean	Indicates whether the request was successful. Valid values: `true` `false`	true
Msg	string	The additional information.	OK
Info	object	The Info-level information.
RegionId	string	The region ID.	cn-hangzhou
GlobalViewClusterId	string	The ID of the global aggregation instance.	global-v2-cn-1483223059272121-jmjjfznz
FailedInstances	string	The list of instances that failed to be added.	\[{"sourceName": "Data source name- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]
RequestId	string	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 time	Summary of changes	Operation
2023-03-20	The response structure of the API has changed	View Change Details