文档

DescribePropertyScaItem - 查询资产指纹调查中间件列表

更新时间:

查询资产指纹调查中间件列表。

调试

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

授权信息

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

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

请求参数

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

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
en
ForceFlushboolean

设置是否强制刷新待查询数据。取值:

  • true:强制刷新
  • false:不强制刷新
false
Bizstring

要查询的资产指纹的类型,默认值为 sca。取值:

  • sca:中间件
  • sca_database:数据库
  • sca_web:Web 服务
说明 不设置此参数时,默认取值为 sca,表示查询中间件类型的资产指纹信息。
sca
SearchItemstring

设置查询条件的类型。取值:

  • name:中间件、数据库或 Web 服务的名称。
  • type:中间件、数据库或 Web 服务的类型。
说明 SearchItemSearchInfo 这两个参数配合使用,通过同时设置这两个参数(设置一个无效),您可以按照资产指纹的名称或类型查看指定名称或类型资产指纹的所有数据。
type
SearchInfostring

要查询的内容。根据 SearchItem 取值的不同,您需要输入不同的查询内容:

  • SearchItem 取值为 name 时,您需要输入的查询条件为资产指纹的名称。
  • SearchItem 取值为 type 时,您需要选择要查询的资产指纹的类型。可选以下取值:
    • system_service:系统服务
    • software_library:软件库
    • docker_component:容器组件
    • database:数据库
    • web_container:Web 容器
    • jar:Jar 包
    • web_framework:Web 框架
说明 SearchItemSearchInfo 这两个参数配合使用,通过同时设置这两个参数(设置一个无效),您可以按照资产指纹的名称或类型查看指定名称或类型资产指纹的所有数据。
system_service
CurrentPageinteger

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

1
PageSizeinteger

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

说明 建议 PageSize 取值不要为空。
20

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

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

3F4236AB-7070-538D-85EB-98EBFE6C****
PageInfoobject

页面显示的信息。

CurrentPageinteger

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

1
PageSizeinteger

分页查询时,每页显示的资产指纹调查中间件信息的数量。

20
TotalCountinteger

查询到的资产指纹调查中间件信息的总数量。

27
Countinteger

当前页面显示的资产指纹调查中间件信息的数量。

20
PropertyItemsobject []

资产指纹调查中间件信息集合。

TypeDisplaystring

中间件类型展示名称。

Docker Component
Namestring

中间件名称。

kubelet
Countinteger

中间件对应的服务器数量。

23
BizTypestring

中间件、数据库或 Web 服务的类型。取值:

  • system_service:系统服务
  • software_library:软件库
  • docker_component:容器组件
  • database:数据库
  • web_container:Web 容器
  • jar:Jar 包
  • web_framework:Web 框架
docker_component

示例

正常返回示例

JSON格式

{
  "RequestId": "3F4236AB-7070-538D-85EB-98EBFE6C****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 27,
    "Count": 20
  },
  "PropertyItems": [
    {
      "TypeDisplay": "Docker Component",
      "Name": "kubelet",
      "Count": 23,
      "BizType": "docker_component"
    }
  ]
}

错误码

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

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

  • 本页导读 (1)
文档反馈