文档

DescribeClusterResources - 查询指定集群的关联资源

更新时间:

您在使用容器服务 Kubernetes 版过程中,会同时使用其他关联的阿里云云产品资源。您可以调用DescribeClusterResources接口查询指定集群的关联资源,例如VPC、SLB等。如果您需要查询节点池或节点资源,您可以调用DescribeClusterNodePools或DescribeClusterNodes接口。

调试

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

授权信息

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

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

请求语法

GET /clusters/{ClusterId}/resources

请求参数

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

集群 ID。

关于如何查看集群 ID,请参见查看集群信息

您也可通过 API 接口 DescribeClustersV1 ,查看阿里云账号下所有创建的集群信息。

cb95aa626a47740afbf6aa099b65****
with_addon_resourcesboolean

是否同时查询集群组件创建的资源。

返回参数

名称类型描述示例值
object []

资源对象列表。

cluster_idstring

集群 ID。

cb95aa626a47740afbf6aa099b65****
createdstring

资源创建时间。

2023-08-15T14:34:42+08:00
instance_idstring

资源 ID。

ngw-wz9sphwk42sdtjixo****
resource_infostring

资源信息。关于资源的源信息,请参见 ListStackResources

{\"Id\":\"k8s_NAT_Gateway\",\"Name\":\"k8s_NAT_Gateway\",\"Type\":\"ALIYUN::VPC::NatGateway\",\"Status\":\"CREATE_COMPLETE\",\"StatusReason\":\"state changed\",\"Updated\":\"2023-08-15T06:33:10\",\"PhysicalId\":\"ngw-wz9sphwk42sdtjixo****\"}
resource_typestring

资源类型。

ALIYUN::VPC::NatGateway
statestring

资源状态。可选值:

  • CREATE_COMPLETE:成功创建资源。
  • CREATE_FAILED:创建资源失败。
  • CREATE_IN_PROGRESS:创建资源中。
  • DELETE_FAILED:删除资源失败。
  • DELETE_IN_PROGRESS:删除资源中。
  • ROLLBACK_COMPLETE:成功回滚。
  • ROLLBACK_FAILED:回滚失败。
  • ROLLBACK_IN_PROGRESS:回滚中。
CREATE_COMPLETE
auto_createlong

资源是否由 ACK 创建:

  • 1:表示由 ACK 创建
  • 0:表示该资源为已有资源
1
dependenciesobject []

依赖资源列表。

cluster_idstring

依赖资源的集群 ID。

cc5ee03f63e43425cb6f71f1a1756****
resource_typestring

依赖资源类型。

ALIYUN::VPC::NatGateway
instance_idstring

依赖资源实例 ID。

ngw-wz9sphwk42sdtjixo****
associated_objectobject

资源关联的 k8s 对象。

kindstring

k8s 对象类型。

Service
namespacestring

k8s 对象命名空间。

kube-system
namestring

k8s 对象名称。

nginx-ingress-lb
delete_behaviorobject

删除集群时该资源的删除行为。

delete_by_defaultboolean

删除集群时是否默认删除该资源。

false
changeableboolean

delete_by_default 中返回的默认行为是否可以更改。

false
creator_typestring

该资源创建者的类型。可能的取值:

  • user:由用户自行创建;
  • system:由 ACK 管控系统创建;
  • addon:由集群组件创建。
addon
extra_infoobject

资源的其他信息。

{"IP": "xx.xx.xx.xx"}

示例

正常返回示例

JSON格式

[
  {
    "cluster_id": "cb95aa626a47740afbf6aa099b65****",
    "created": "2023-08-15T14:34:42+08:00",
    "instance_id": "ngw-wz9sphwk42sdtjixo****",
    "resource_info": "{\\\"Id\\\":\\\"k8s_NAT_Gateway\\\",\\\"Name\\\":\\\"k8s_NAT_Gateway\\\",\\\"Type\\\":\\\"ALIYUN::VPC::NatGateway\\\",\\\"Status\\\":\\\"CREATE_COMPLETE\\\",\\\"StatusReason\\\":\\\"state changed\\\",\\\"Updated\\\":\\\"2023-08-15T06:33:10\\\",\\\"PhysicalId\\\":\\\"ngw-wz9sphwk42sdtjixo****\\\"}",
    "resource_type": "ALIYUN::VPC::NatGateway",
    "state": "CREATE_COMPLETE",
    "auto_create": 1,
    "dependencies": [
      {
        "cluster_id": "cc5ee03f63e43425cb6f71f1a1756****",
        "resource_type": "ALIYUN::VPC::NatGateway",
        "instance_id": "ngw-wz9sphwk42sdtjixo****"
      }
    ],
    "associated_object": {
      "kind": "Service",
      "namespace": "kube-system",
      "name": "nginx-ingress-lb"
    },
    "delete_behavior": {
      "delete_by_default": false,
      "changeable": false
    },
    "creator_type": "addon",
    "extra_info": {
      "IP": "xx.xx.xx.xx"
    }
  }
]

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-13OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:with_addon_resources
出参OpenAPI 返回结构发生变更
2023-10-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-10-11OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2020-09-10OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)