ListDataSets - 获取数据集列表

获取数据集列表。

调试

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

授权信息

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

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

请求参数

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

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地。
  • ap-southeast-1:资产属于海外地域。
cn-hangzhou
Langstring

返回消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh
DataSetIdstring

数据集 ID。

dataset-qt0n8246gs9nackg****
DataSetNamestring

数据集名称。

lmftest
DataSetStatusinteger

数据集状态。取值:

  • 0:删除 。
  • 1:启用。
0
OrderFieldNamestring

排序字段。取值:

  • GmtCreate:创建时间 。
  • GmtModified:更新时间。
GmtCreate
OrderDirectionstring

排序方向,取值为:

  • asc(默认值):正序。
  • desc:倒序。
asc
PageNumberinteger

分页参数:当前页码。

1
PageSizeinteger

分页参数:每页显示条数。

10
DataSetIdsarray

数据集 ID 列表。

string

数据集 ID 列表。

["dataset-1lz4nf2x08mklchy****"]
RoleForlong

管理员切换成其他成员视角的用户 ID。

113091674488****
MaxResultsinteger

使用 NextToken 方式查询时,每次最多返回的结果数。取值范围:1~100。默认值:50。

50
NextTokenstring

下一个查询开始 Token。

AAAAAUqcj6VO4E3ECWIrFczs****
DataSetTypestring

数据集类型。取值:

  • custom:自定义。
  • preset:预定义。
custom

返回参数

名称类型描述示例值
object

返回体。

RequestIdstring

请求消息 ID。

157CFBB5-B56F-566F-8991-B3C51799****
DataSetsarray<object>

数据集列表。

dataobject

数据集。

CreateTimelong

创建时间。

1713787368000
UpdateTimelong

更新时间。

1713787368000
DataSetIdstring

数据集 ID。

dataset-t8ha6p7k61rmniqw****
DataSetNamestring

数据集名称。

lmftest
DataSetDescriptionstring

数据集描述。

lmftest desc
DataSetFieldNamesstring

数据集字段名称。

["ip","region"]
DataSetFieldKeyNamestring

数据集唯一键名称。

ip
DataSetFileNamestring

上传的数据集文件名称。

cloudsiem-dataset/1358117679873357_174338773****.csv
DataSetStatusinteger

数据集状态。取值:

  • 0:删除。
  • 1:启用。
1
DataSetReferencesarray<object>

数据集引用数据。

dataSetReferencesobject

数据集引用数据。

DataSetIdstring

数据集 ID。

dataset-nhcrmjpx1zsorlaq****
DataSetReferenceTypestring

与数据集关联的服务类型。取值:

  • custom_rule:自定义规则 。
  • playbook:剧本。
playbook
DataSetReferenceIdstring

与数据集关联的规则或剧本 id。

456232
DataSetReferenceNamestring

与数据集关联的规则或剧本名称。

playbook_name
DataSetTypestring

数据集类型。取值:

  • custom:自定义。
  • preset:预定义。
preset
IpWhitelistRecognizersarray<object>

识别器列表。

ipWhitelistRecognizersobject

识别器。

IpWhitelistRecognizerTypestring

识别器识别的 IP 类型。取值:

  • sas_vulnerability_scanner_ip:云安全中心漏洞 Web 扫描器 IP 地址。
  • waf_back_source_ip:Web 应用防火墙回源 IP 地址。
  • ddos_back_source_ip:DDoS 防护回源 IP 地址。
  • esa_back_source_ip:边缘安全加速 ESA 回源节点 IP 地址。
  • ecs_public_ip:云服务器 ECS 公网 IP 地址。
  • slb_public_ip:负载均衡 SLB 公网 IP 地址。
  • vpc_eip:弹性公网 IP(EIP)地址。
  • cdn_back_source_ip:内容分发网络 CDN 回源 IP 地址。
  • ga_back_source_ip:全球加速 GA 回源 IP 地址。
waf_back_source_ip
AutoRecognizeStatusstring

自动识别状态。取值:

  • enabled:已启用。
  • disabled:未启用。
enabled
RecognizeScopestring

识别范围。取值:

  • current_account:仅当前账户。
  • rd_accounts:开启多账号。
current_account
UpdateTimelong

更新时间。

1713787368000
PageNumberinteger

分页参数:当前页码。

1
PageSizeinteger

分页参数:每页显示条数。

10
TotalCountinteger

记录总数。

57
MaxResultsinteger

使用 NextToken 方式查询时,每次最多返回的结果数。取值范围:1~100。默认值:50。

50
NextTokenstring

下一个查询开始 Token。

AAAAAUqcj6VO4E3ECWIrFczs****

示例

正常返回示例

JSON格式

{
  "RequestId": "157CFBB5-B56F-566F-8991-B3C51799****",
  "DataSets": [
    {
      "CreateTime": 1713787368000,
      "UpdateTime": 1713787368000,
      "DataSetId": "dataset-t8ha6p7k61rmniqw****",
      "DataSetName": "lmftest",
      "DataSetDescription": "lmftest desc",
      "DataSetFieldNames": [
        "ip",
        "region"
      ],
      "DataSetFieldKeyName": "ip",
      "DataSetFileName": "cloudsiem-dataset/1358117679873357_174338773****.csv",
      "DataSetStatus": 1,
      "DataSetReferences": [
        {
          "DataSetId": "dataset-nhcrmjpx1zsorlaq****",
          "DataSetReferenceType": "playbook",
          "DataSetReferenceId": 456232,
          "DataSetReferenceName": "playbook_name"
        }
      ],
      "DataSetType": "preset",
      "IpWhitelistRecognizers": [
        {
          "IpWhitelistRecognizerType": "waf_back_source_ip",
          "AutoRecognizeStatus": "enabled",
          "RecognizeScope": "current_account",
          "UpdateTime": 1713787368000
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 57,
  "MaxResults": 50,
  "NextToken": "AAAAAUqcj6VO4E3ECWIrFczs****"
}

错误码

HTTP status code错误码错误信息
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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