All Products
Search
Document Center

Managed Service for Prometheus:GetCloudClusterAllUrl

Last Updated:May 09, 2024

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

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetCloudClusterAllUrlWrite
  • Prometheus
    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-beijing
ClusterIdstringNo

The ID of the CloudMonitor instance.

ca9676014babd4

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

99A663CB-8D7B-4B0D-A006-03C8EE38E7BB
Dataobject []

An array object.

ProductCodestring

The identifier of the cloud service.

amp
Regionstring

The region ID.

cn-hangzhou
RemoteUrlobject

The URLs for remote read and write. The value is a JSON string.

RemoteWriteUrlstring

The internal URL for remote write.

"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetRemoteWriteUrlstring

The public URL for remote write.

"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
RemoteReadUrlstring

The internal URL for remote read.

"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetRemoteReadUrlstring

The public URL for remote read.

"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
GrafanaUrlstring

The internal URL for Grafana.

"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetGrafanaUrlstring

The public URL for Grafana.

"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
InternetPushGatewayUrlstring

The public URL for Pushgateway.

"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
PushGatewayUrlstring

The internal URL for Pushgateway.

"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"
AuthTokenboolean

Indicates whether authentication is enabled.

true
Tokenstring

The token value used for authentication.

"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw"

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 timeSummary of changesOperation
2024-02-05The API operation is deprecatedsee changesets
Change itemChange content
API Deprecation DescriptionThe API operation is deprecated.
2023-03-23The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.