ListKspmInstances - 查询Kubernetes资产

更新时间:
复制 MD 格式

查询Kubernetes资产信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ListKspmInstances

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

实例所在的地域的 ID。

cn-hangzhou

Criteria

string

设置搜索资产的条件。该参数 JSON 格式,输入参数时注意大小写。包含一下字段:

  • name:检索项

  • value:检索项值

  • logicalExp:多条件时,检索项之间的关系,取值:
    • OR:表示多个条件间为的关系。

    • AND:表示多个条件间为的关系。

说明

支持使用地域、实例名称、实例 ID、告警状态、风险状态、标签搜索条件。

[{"name":"vulStatus","value":"YES","logicalExp":"AND"}]

LogicalExp

string

设置多个搜索条件间生效的逻辑关系。取值:

  • OR:表示多个搜索条件之间是的关系。

  • AND:表示多个搜索条件之间是的关系。

OR

PageSize

integer

分页查询时,显示的每页数据的最大条数。默认值为 20。

20

CurrentPage

integer

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1

CloudAssetTypes

array<object>

Kubernetes 资产的资产类型信息列表。

object

Kubernetes 资产的资产类型信息。

AssetType

integer

资产的类型。取值:

  • 0:Workload

  • 1:Service

  • 2:Namespace

  • 3:Authorization

  • 4:Storage

  • 5:Container

  • 6:Network

  • 7:Configuration

  • 8:Policies

0

AssetSubType

integer

产品的子类型。 资产的类型-子类型。取值:

  • 0:Workload
    • 0:Pod

    • 1:DaemonSet

    • 2:StatefulSet

  • 1:Service
    • 0:Service

  • 2:Namespace
    • 0:Namespace

  • 3:Authorization
    • 0:Role

    • 1:ClusterRole

    • 2:ClusterRoleBinding

    • 3:RoleBinding

    • 4:ServiceAccount

  • 4:Storage
    • 0:PersistentVolume

    • 1:PersistentVolumeClaim

    • 2:StorageClass

  • 5:Container
    • 0:Image

  • 6:Network
    • 0:Route

    • 0:Ingress

  • 7:Configuration
    • 0:ConfigMap

  • 8:Policies
    • 0:LimitRanges

    • 1:ResourceQuota

0

Vendor

integer

资产厂商。这里固定取值 200

200

返回参数

名称

类型

描述

示例值

object

请求返回数据。

Success

boolean

接口调用是否成功。取值:

  • true:成功

  • false:失败

true

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1

PageInfo

object

分页查询时的页面信息。

CurrentPage

integer

分页查询时,当前页的页码。

1

PageSize

integer

分页查询时,显示的每页数据的最大条数。

20

TotalCount

integer

查询到的数据总条数。

55

Count

integer

当前页显示的数据条数。

4

Instances

array<object>

Kubernetes 资产信息列表。

object

Kubernetes 资产信息

RegionId

string

资产所在的地域的 ID。

cn-hanghzou

Vendor

integer

资产厂商。这里固定取值 200

200

AssetType

integer

资产的类型。

1

AssetSubType

string

资产的子类型。

1

InstanceId

string

实例 ID。

rm-uf6t6u05n6g48****

InstanceName

string

实例名称。

yztest-l***

CreatedTime

integer

实例创建时间戳。单位:毫秒。

1607365213000

InternetIp

string

实例的公网 IP。

1.2.XX.XX

AlarmStatus

string

资产是否存在安全告警。取值:

  • YES:存在安全告警

  • NO:不存在安全告警

NO

RiskStatus

string

资产是否存在安全风险。取值:

  • YES:存在

  • NO:不存在

NO

AssetTypeName

string

资产的类型名称。

Workload

AssetSubTypeName

string

资产的子类型名称。

Pod

SecurityInfo

string

资产的安全信息。

{\"seriousNum\":0,\"appNum\":0,\"baselineMedium\":0,\"remindNum\":0,\"imageVulNntf\":0,\"cveNum\":0,\"vul\":0,\"uuid\":\"rm-uf6t6u05n6g485o70\",\"emgNum\":0,\"weakPWNum\":0,\"imageMaliciousFileRemind\":0,\"imageBaselineMedium\":0,\"laterVulCount\":0,\"cmsNum\":0,\"imageMaliciousFileSerious\":0,\"agentlessMalicious\":0,\"suspNum\":0,\"imageBaselineHigh\":0,\"asapVulCount\":0,\"imageVulLater\":0,\"agentlessAll\":0,\"sysNum\":0,\"containerLater\":0,\"containerSuspicious\":0,\"imageBaselineNum\":0,\"newSuspicious\":0,\"nntfVulCount\":0,\"scaNum\":0,\"containerNntf\":0,\"health\":0,\"trojan\":0,\"suspicious\":0,\"imageMaliciousFileSuspicious\":0,\"containerRemind\":0,\"baselineLow\":0,\"imageVulAsap\":0,\"imageBaselineLow\":0,\"containerAsap\":0,\"agentlessBaseline\":0,\"agentlessVulSca\":0,\"agentlessVulCve\":0,\"containerSerious\":0,\"baselineHigh\":0,\"account\":0,\"baselineNum\":6}

Tags

array

资源标签列表。

string

资源标签。

AI

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 55,
    "Count": 4
  },
  "Instances": [
    {
      "RegionId": "cn-hanghzou",
      "Vendor": 200,
      "AssetType": 1,
      "AssetSubType": "1",
      "InstanceId": "rm-uf6t6u05n6g48****",
      "InstanceName": "yztest-l***",
      "CreatedTime": 1607365213000,
      "InternetIp": "1.2.XX.XX",
      "AlarmStatus": "NO",
      "RiskStatus": "NO",
      "AssetTypeName": "Workload",
      "AssetSubTypeName": "Pod",
      "SecurityInfo": "{\\\"seriousNum\\\":0,\\\"appNum\\\":0,\\\"baselineMedium\\\":0,\\\"remindNum\\\":0,\\\"imageVulNntf\\\":0,\\\"cveNum\\\":0,\\\"vul\\\":0,\\\"uuid\\\":\\\"rm-uf6t6u05n6g485o70\\\",\\\"emgNum\\\":0,\\\"weakPWNum\\\":0,\\\"imageMaliciousFileRemind\\\":0,\\\"imageBaselineMedium\\\":0,\\\"laterVulCount\\\":0,\\\"cmsNum\\\":0,\\\"imageMaliciousFileSerious\\\":0,\\\"agentlessMalicious\\\":0,\\\"suspNum\\\":0,\\\"imageBaselineHigh\\\":0,\\\"asapVulCount\\\":0,\\\"imageVulLater\\\":0,\\\"agentlessAll\\\":0,\\\"sysNum\\\":0,\\\"containerLater\\\":0,\\\"containerSuspicious\\\":0,\\\"imageBaselineNum\\\":0,\\\"newSuspicious\\\":0,\\\"nntfVulCount\\\":0,\\\"scaNum\\\":0,\\\"containerNntf\\\":0,\\\"health\\\":0,\\\"trojan\\\":0,\\\"suspicious\\\":0,\\\"imageMaliciousFileSuspicious\\\":0,\\\"containerRemind\\\":0,\\\"baselineLow\\\":0,\\\"imageVulAsap\\\":0,\\\"imageBaselineLow\\\":0,\\\"containerAsap\\\":0,\\\"agentlessBaseline\\\":0,\\\"agentlessVulSca\\\":0,\\\"agentlessVulCve\\\":0,\\\"containerSerious\\\":0,\\\"baselineHigh\\\":0,\\\"account\\\":0,\\\"baselineNum\\\":6}",
      "Tags": [
        "AI"
      ]
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 AccountIdNotExist AccountId not exist
400 NoPermission no permission
500 ServerError ServerError
403 NoPermission caller has no permission

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

变更历史

更多信息,参考变更详情