全部产品
Search
文档中心

应用实时监控服务ARMS:GetCloudClusterAllUrl - 获取云产品各种URL

更新时间:Nov 05, 2024
目前该API接口已标记为弃用,推荐使用替代API:ARMS(2019-08-08) - GetRemoteWriteUrl

获取云监控云产品读写地址,pushgateway,grafana 地址。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:GetCloudClusterAllUrlnone
  • Prometheus
    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。例如 cn-hangzhou。

cn-beijing
ClusterIdstring

云监控实例 ID

ca9676014babd4

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

99A663CB-8D7B-4B0D-A006-03C8EE38E7BB
Dataarray<object>

数组类型

Dataobject

聚合实例列表,为 JSON 格式字符串。

ProductCodestring

云产品标识

amp
Regionstring

地域。

cn-hangzhou
RemoteUrlobject

读写对象 json 结构

RemoteWriteUrlstring

内网远程写地址

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

公网远程写地址

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

内网远程读地址

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

公网远程读地址

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

内网 grafana 数据源地址

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

公网 grafana 数据源地址

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

公网 pushgateway 地址

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

内网 pushgateway 地址

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

是否开启鉴权

true
Tokenstring

如果开启,token 的值

"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw"
Codeinteger

状态码。200 为成功,其他状态码为异常。

200
Messagestring

详细信息。

success
Successboolean

操作是否成功:true:操作成功 false:操作失败

true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-05OpenAPI 变更为 deprecated,即将下线查看变更详情
2023-03-23OpenAPI 返回结构发生变更查看变更详情