文档

ListPrometheusInstanceByTagAndResourceGroupId - 根据标签和资源组查询Prometheus实例

更新时间:

根据标签和资源组查询Prometheus实例。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ResourceGroupIdstring

资源组 ID。

rg-acfmxyexli2****
Tagarray<object>

标签列表。

object

资源的标签。

Keystring

标签键。

fpx-tag
Valuestring

标签值。

fvt-tag-value

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

4789C3E9-A85A-524B-B97B-9D2B14BA06BC
Dataobject

返回结构体。

PrometheusInstancesarray<object>

Prometheus 实例列表。

object
ClusterIdstring

Prometheus 实例 ID。

c9d5dda1aeca64220853ace304baeb03d
RegionIdstring

地域 ID。

cn-shanghai
UserIdstring

用户 ID。

1672753017899***
ClusterNamestring

Prometheus 实例名。

prom1
ClusterTypestring

remote-write(Prometheus for Remote Write)

  • remote-write(Prometheus for Remote Write)
  • ecs(Prometheus for ECS)
  • cloud-monitor(Prometheus for 云服务中国内地)
  • cloud-product(Prometheus for 云服务国外)
  • global-view(Prometheus for GlobalView)
  • aliyun-cs(Prometheus for 容器服务)
ecs
VpcIdstring

VPC ID。

vpc-8vbtp1fsm8mir18l8rl0u
VSwitchIdstring

交换机 ID。

vsw-f8z73vcja1tqnw90aav5a
SecurityGroupIdstring

安全组 ID。

sg-f8zd1toc10wmbi1v5rom
SubClustersJsonstring

globalView 实例的子实例 json 串。

[ { "headers": {}, "regionId": "cn-hangzhou", "sourceType": "AlibabaPrometheus", "extras": {}, "clusterId": "c39a1048921e04fceb039db2fb****", "sourceName": "arms-luyao-test", "dataSource": "", "userId": "167275301789****" }, { "headers": {}, "regionId": "cn-beijing", "sourceType": "AlibabaPrometheus", "extras": {}, "clusterId": "c6b6485496d5b400abde22cb47b5****", "sourceName": "agent-321-测试", "dataSource": "", "userId": "167275301789****" }, { "headers": {}, "regionId": "cn-zhangjiakou", "sourceType": "AlibabaPrometheus", "extras": {}, "clusterId": "c261a4f3200c446659133f1ade78****", "sourceName": "zaifeng-cardinality-01", "dataSource": "", "userId": "167275301789****" } ]
RemoteReadIntraUrlstring

Remote Read 内网地址。

http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read
RemoteReadInterUrlstring

Remote Read 公网地址。

http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read
RemoteWriteIntraUrlstring

Remote Write 内网地址。

http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write
RemoteWriteInterUrlstring

Remote Write 公网地址。

https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write
PushGatewayIntraUrlstring

Push Gateway 内网地址。

http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2
PushGatewayInterUrlstring

Push Gateway 公网地址。

https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2
HttpApiIntraUrlstring

HTTP API 内网地址。

http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx
HttpApiInterUrlstring

HTTP API 公网地址。

https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx
AuthTokenstring

授权 Token 串。

GciOiJIUzI1NiJ9***
PaymentTypestring

付费类型。

  • PREPAY-包年包月
  • POSTPAY-按量付费
POSTPAY
GrafanaInstanceIdstring

Grafana 工作区 ID。

grafana-rnggfvhlcdl6m71l**
ResourceGroupIdstring

Prometheus 实例的资源组 ID。

rg-acfmz7nocpeidcy
ResourceTypestring

资源类型

PROMETHEUS
Tagsarray<object>

标签列表。

object

实例的标签值。

TagKeystring

标签键。

ac-cus-tag-3
TagValuestring

标签值。

asg-2vc8qq7x89o11rus9uvu
Codestring

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

200
Messagestring

返回结果的提示信息。

message

示例

正常返回示例

JSON格式

{
  "RequestId": "4789C3E9-A85A-524B-B97B-9D2B14BA06BC",
  "Data": {
    "PrometheusInstances": [
      {
        "ClusterId": "c9d5dda1aeca64220853ace304baeb03d",
        "RegionId": "cn-shanghai",
        "UserId": "1672753017899***",
        "ClusterName": "prom1",
        "ClusterType": "ecs",
        "VpcId": "vpc-8vbtp1fsm8mir18l8rl0u",
        "VSwitchId": "vsw-f8z73vcja1tqnw90aav5a",
        "SecurityGroupId": "sg-f8zd1toc10wmbi1v5rom",
        "SubClustersJson": "[\n  {\n    \"headers\": {},\n    \"regionId\": \"cn-hangzhou\",\n    \"sourceType\": \"AlibabaPrometheus\",\n    \"extras\": {},\n    \"clusterId\": \"c39a1048921e04fceb039db2fb****\",\n    \"sourceName\": \"arms-luyao-test\",\n    \"dataSource\": \"\",\n    \"userId\": \"167275301789****\"\n  },\n  {\n    \"headers\": {},\n    \"regionId\": \"cn-beijing\",\n    \"sourceType\": \"AlibabaPrometheus\",\n    \"extras\": {},\n    \"clusterId\": \"c6b6485496d5b400abde22cb47b5****\",\n    \"sourceName\": \"agent-321-测试\",\n    \"dataSource\": \"\",\n    \"userId\": \"167275301789****\"\n  },\n  {\n    \"headers\": {},\n    \"regionId\": \"cn-zhangjiakou\",\n    \"sourceType\": \"AlibabaPrometheus\",\n    \"extras\": {},\n    \"clusterId\": \"c261a4f3200c446659133f1ade78****\",\n    \"sourceName\": \"zaifeng-cardinality-01\",\n    \"dataSource\": \"\",\n    \"userId\": \"167275301789****\"\n  }\n]",
        "RemoteReadIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read",
        "RemoteReadInterUrl": "http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read",
        "RemoteWriteIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write",
        "RemoteWriteInterUrl": "https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write",
        "PushGatewayIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2",
        "PushGatewayInterUrl": "https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2",
        "HttpApiIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx\n",
        "HttpApiInterUrl": "https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx",
        "AuthToken": "GciOiJIUzI1NiJ9***",
        "PaymentType": "POSTPAY",
        "GrafanaInstanceId": "grafana-rnggfvhlcdl6m71l**",
        "ResourceGroupId": "rg-acfmz7nocpeidcy",
        "ResourceType": "PROMETHEUS",
        "Tags": [
          {
            "TagKey": "ac-cus-tag-3",
            "TagValue": "asg-2vc8qq7x89o11rus9uvu"
          }
        ]
      }
    ]
  },
  "Code": "200",
  "Message": "message"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 返回结构发生变更查看变更详情
2023-06-21OpenAPI 入参发生变更查看变更详情
2023-05-17OpenAPI 入参发生变更查看变更详情
2023-03-30OpenAPI 返回结构发生变更查看变更详情