全部产品
Search
文档中心

云安全中心:DescribeContainerGroupedFieldDetail - 查询容器属性详情

更新时间:Nov 25, 2024

查询容器属性详情。

调试

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

授权信息

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

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

请求参数

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

设置搜索资产的条件。该参数为 JSON 格式,多个条件之间使用半角逗号(,)分隔。例如:[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]

说明 支持使用实例 ID、实例名称、所属 VPC ID、地域、公网 IP 地址等条件搜索资产。您可以调用 DescribeCriteria 查询支持的搜索条件。
[{\"name\":\"clusterId\",\"value\":\"cfd26658431084c73a48dd97328ba8acf\"}]
GroupFieldstring

检索项。取值:

  • pod:pod。
  • appName:应用名称。
  • clusterId:集群编号。
  • namespace:命名空间。
  • image:镜像。
  • containerScan:容器扫描。
pod

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求 ID。

7532B7EE-7CE7-5F4D-BF04-B12447DD****
Dataobject

返回数据。

Podstring

POD 名称。

node-local-dns-zwsxl
CreateTimelong

创建时间。

1702433618301
ContainerCountinteger

容器数量。

1
Namespacestring

命名空间。

default
ClusterStatestring

集群状态。取值范围:

  • STARTING:启动中。
  • START_FAILED:启动失败。
  • BOOTSTRAPPING:引导操作初始化。
  • RUNNING:运行中。
  • TERMINATING:终止中。
  • TERMINATED:已终止。
  • TERMINATED_WITH_ERRORS:发生异常导致终止
  • TERMINATE_FAILED:终止失败。
RUNNING
RegionIdstring

地域 ID。

cn-shanghai
AppNamestring

应用名称。

node-local-dns
InstanceCountinteger

实例数量。

1
ClusterTypestring

集群的类型。取值:

  • Kubernetes:Kubernetes 专有版。
  • ManagedKubernetes:标准托管集群(边缘集群)。
  • Ask:标准 Serverless 集群。
ManagedKubernetes
NodeNamestring

节点名称。

shangliang-test
PodCountinteger

POD 数量。

1
ClusterNamestring

集群名称。

zhhtest
PodIpstring

POD 的 IP。

192.168.1.1
ClusterCurrentVersionstring

集群当前在线服务器的版本。

1.14.8-aliyun.1
VulCountinteger

漏洞数量。

1
AlarmCountinteger

告警数量。

1
ClusterIdstring

集群 ID。

c8ca91e0907d94efaba7fb0827eb9****

示例

正常返回示例

JSON格式

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DD****",
  "Data": {
    "Pod": "node-local-dns-zwsxl",
    "CreateTime": 1702433618301,
    "ContainerCount": 1,
    "Namespace": "default",
    "ClusterState": "RUNNING",
    "RegionId": "cn-shanghai",
    "AppName": "node-local-dns",
    "InstanceCount": 1,
    "ClusterType": "ManagedKubernetes",
    "NodeName": "shangliang-test",
    "PodCount": 1,
    "ClusterName": "zhhtest",
    "PodIp": "192.168.1.1",
    "ClusterCurrentVersion": "1.14.8-aliyun.1",
    "VulCount": 1,
    "AlarmCount": 1,
    "ClusterId": "c8ca91e0907d94efaba7fb0827eb9****"
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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