调用ListEnvironmentKubeResources API查询环境的K8s资源-可观测监控 Prometheus 版-阿里云-可观测监控 Prometheus 版(Prometheus)-阿里云帮助中心

查看环境的K8s资源。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

arms:ListEnvironmentKubeResources

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EnvironmentId	string	是	环境 ID。	env-xxx
RegionId	string	否	地域 ID。	cn-hangzhou
Kind	string	是	资源 Kind Pod \| Deployment \| Service 等。	Pod
Namespace	string	否	命名空间。	default
LabelSelectors	object	否	标签选择。
	string	否	标签。	{"app":"mysql"}

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	Id of the request	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	状态码。200 为成功，其他状态码为异常。	200
Success	boolean	操作是否成功： `true`：操作成功。 `false`：操作失败。	true
Message	string	返回结果的提示信息。	message
Data	array<object>	返回结构体。
	array<object>	返回结构体。
ApiVersion	string	API 版本号。	v1
Kind	string	K8s 资源 Kind。	Pod
Metadata	object	元数据。
Annotations	object	注释列表。
	string	注释列表。	{ "kubernetes.io/psp": "ack.privileged", "k8s.aliyun.com/pod-ips": "172.16.0.188" }
Labels	object	标签列表。
	string	标签列表。	{ "app": "arms-prometheus-ack-arms-prometheus", "releaseRevision": "1", "release": "arms-prometheus", "pod-template-hash": "c577b6cc8", "heritage": "Helm", "chart": "ack-arms-prometheus-1.1.17" }
Name	string	资源名称。	arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd
Namespace	string	命名空间。	arms-prom
Spec	any	资源 Spec。	{ "dnsPolicy": "ClusterFirst", "nodeName": "cn-hangzhou.172.16.0.60", "terminationGracePeriodSeconds": 30, "enableServiceLinks": true, "serviceAccountName": "arms-prom-operator", "volumes": [ { "name": "certs", "secret": { "secretName": "arms-prometheus-ack-arms-prometheus-cert", "defaultMode": 420 } }
Status	any	资源状态。	run

示例

正常返回示例

JSON格式

{
  "RequestId": "C21AB7CF-B7AF-410F-BD61-82D1567F****",
  "Code": 200,
  "Success": true,
  "Message": "message",
  "Data": [
    {
      "ApiVersion": "v1",
      "Kind": "Pod",
      "Metadata": {
        "Annotations": {
          "key": " {\n          \"kubernetes.io/psp\": \"ack.privileged\",\n          \"k8s.aliyun.com/pod-ips\": \"172.16.0.188\"\n        }"
        },
        "Labels": {
          "key": "{\n          \"app\": \"arms-prometheus-ack-arms-prometheus\",\n          \"releaseRevision\": \"1\",\n          \"release\": \"arms-prometheus\",\n          \"pod-template-hash\": \"c577b6cc8\",\n          \"heritage\": \"Helm\",\n          \"chart\": \"ack-arms-prometheus-1.1.17\"\n        }"
        },
        "Name": "arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd",
        "Namespace": "arms-prom"
      },
      "Spec": "{\n        \"dnsPolicy\": \"ClusterFirst\",\n        \"nodeName\": \"cn-hangzhou.172.16.0.60\",\n        \"terminationGracePeriodSeconds\": 30,\n        \"enableServiceLinks\": true,\n        \"serviceAccountName\": \"arms-prom-operator\",\n        \"volumes\": [\n          {\n            \"name\": \"certs\",\n            \"secret\": {\n              \"secretName\": \"arms-prometheus-ack-arms-prometheus-cert\",\n              \"defaultMode\": 420\n            }\n          }\n",
      "Status": "run"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。