GetCloudClusterAllUrl - Application Real-Time Monitoring Service

This API is deprecated. You are advised to use ARMS(2019-08-08) - GetRemoteWriteUrl.

Queries the read and write URLs of a CloudMonitor instance, such as Pushgateway and Grafana URLs.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
ClusterId	string	No	The ID of the CloudMonitor instance.	ca9676014babd4

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	99A663CB-8D7B-4B0D-A006-03C8EE38E7BB
Data	array<object>	An array object.
Data	object	The queried global aggregation instances. The value is a JSON string.
ProductCode	string	The identifier of the cloud service.	amp
Region	string	The region ID.	cn-hangzhou
RemoteUrl	object	The URLs for remote read and write. The value is a JSON string.
RemoteWriteUrl	string	The internal URL for remote write.	"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetRemoteWriteUrl	string	The public URL for remote write.	"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
RemoteReadUrl	string	The internal URL for remote read.	"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetRemoteReadUrl	string	The public URL for remote read.	"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
GrafanaUrl	string	The internal URL for Grafana.	"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetGrafanaUrl	string	The public URL for Grafana.	"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetPushGatewayUrl	string	The public URL for Pushgateway.	"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
PushGatewayUrl	string	The internal URL for Pushgateway.	"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
AuthToken	boolean	Indicates whether authentication is enabled.	true
Token	string	The token value used for authentication.	"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw"
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.	200
Message	string	The returned message.	success
Success	boolean	Indicates whether the request was successful. Valid values: true and false.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "99A663CB-8D7B-4B0D-A006-03C8EE38E7BB",
  "Data": [
    {
      "ProductCode": "amp",
      "Region": "cn-hangzhou",
      "RemoteUrl": {
        "RemoteWriteUrl": "\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "InternetRemoteWriteUrl": "\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "RemoteReadUrl": "\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "InternetRemoteReadUrl": "\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"",
        "GrafanaUrl": "\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "InternetGrafanaUrl": "\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "InternetPushGatewayUrl": "\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "PushGatewayUrl": "\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\"\n",
        "AuthToken": true,
        "Token": "\"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw\""
      }
    }
  ],
  "Code": 200,
  "Message": "success",
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-02-05	The API operation is deprecated	View Change Details
2023-03-23	The response structure of the API has changed	View Change Details