文档

ListPublicDatasetEntities - 获取公共数据集实体类型列表

更新时间:

获取平台公共数据集包含的实体类型列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

公共数据集名称

西蒙斯基因组多样性计划
OrderBystring

排序字段

LastModified
IsReversedboolean

是否逆序,默认逆序排列

true
NextTokenstring

翻页 Token 用来标记当前开始读取的位置,置空表示从头开始

0f2cc944-67db-4fb1-bb10-f136cda74bda
MaxResultsinteger

分页数量

10
Locationstring

地域 ID

cn-shanghai

返回参数

名称类型描述示例值
object
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
RequestIdstring

请求 ID

DA980AD0-158F-44F3-847D-5EAB96C0EB6B
NextTokenstring

翻页 Token 用来表示当前调用返回读取到的位置,空代表数据已经读取完毕

ba6d88e2-a6f2-4d2c-a2ae-68b76b078445
MaxResultsinteger

分页数

10
TotalCountinteger

总记录数

100
DatasetNamestring

公共数据集名称

西蒙斯基因组多样性计划
Entitiesobject []

该实体包含的所有类型

EntityTypestring

实体类型

sample

示例

正常返回示例

JSON格式

{
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "NextToken": "ba6d88e2-a6f2-4d2c-a2ae-68b76b078445",
  "MaxResults": 10,
  "TotalCount": 100,
  "DatasetName": "西蒙斯基因组多样性计划",
  "Entities": [
    {
      "EntityType": "sample"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.缺少必要的参数
400InvalidParameterThe specified parameter %s is invalid.无效的参数
400SignatureDoesNotMatchThe specified signature is invalid.签名认证错误
404InvalidUser.NotFoundThe specified user is not found.找不到该用户信息,请先购买开通基因云产品
404InvalidPublicDataset.NotFoundThe specified PublicDatasetName is not found.公共数据集名称不存在。
404InvalidOrderBy.NotFoundThe specified OrderBy is not found.排序字段不存在。

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

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