All Products
Search
Document Center

Application Real-Time Monitoring Service:GetClusterAllUrl

Last Updated:Nov 05, 2024

Obtains all the URLs of a cluster, including remote read and write URLs, Pushgateway URLs, 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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. Default value: cn-hangzhou.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

cc7a37ee31aea4ed1a059eff8034b****

Response parameters

ParameterTypeDescriptionExample
object
Datastring

The response parameters in the JSON format.

{ "RequestId": "41877338-646B-5DD6-BFBE-F89F1E7245AD", "Data": "{\"clusterType\":\"ManagedKubernetes\",\"remoteWriteUrl\":\"http:/" }
RequestIdstring

The request ID.

40B10E04-81E8-4643-970D-F1B38F2E****
Codeinteger

Status code. 200 means success, other status codes are exceptions.

200
Messagestring

The prompt information of the returned result.

success
Successboolean

Whether the query is successful:

  • true: success
  • false: failure
true

Examples

Sample success responses

JSONformat

{
  "Data": "{\n  \"RequestId\": \"41877338-646B-5DD6-BFBE-F89F1E7245AD\",\n  \"Data\": \"{\\\"clusterType\\\":\\\"ManagedKubernetes\\\",\\\"remoteWriteUrl\\\":\\\"http:/\" }",
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****",
  "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-08-29The API operation is deprecatedView Change Details
2023-03-23The response structure of the API has changedView Change Details