文档

GetClusterAllUrl - 获取集群所有地址

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

获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址。

调试

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

授权信息

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

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

请求参数

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

地域 ID。默认为 cn-hangzhou。

cn-hangzhou
ClusterIdstring

集群 ID。

cc7a37ee31aea4ed1a059eff8034b****

返回参数

名称类型描述示例值
object
Datastring

JSON 格式的返回结果。

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

请求 ID。

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

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

200
Messagestring

返回结果的提示信息。

success
Successboolean

查询是否成功:true:成功。 false:失败。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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