AppendInstancesToPrometheusGlobalView - Application Real-Time Monitoring Service

Adds a data source to a global aggregation instance.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
GroupName	string	Yes	The name of the global aggregation instance.	zyGlobalView
Clusters	string	Yes	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 ]
GlobalViewClusterId	string	Yes	The ID of the global aggregation instance.	global-v2-cn-1670100631025794-6gjc0qgb

Response parameters

Parameter	Type	Description	Example
	object
Data	object	The information about the array object.
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The call was successful. `false`: The call failed.	True
Msg	string	The additional information.	OK
Info	string	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.}
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	27E653FA-5958-45BE-8AA9-14D884DC****
Code	integer	Status code. 200 means success, other status codes are exceptions.	200
Message	string	Additional message.	success

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****",
  "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