获取平台公共数据集包含的实体类型列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| easygene:ListPublicDatasetEntities | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DatasetName | string | 是 | 公共数据集名称 | 西蒙斯基因组多样性计划 |
| OrderBy | string | 否 | 排序字段 | LastModified |
| IsReversed | boolean | 否 | 是否逆序，默认逆序排列 | true |
| NextToken | string | 是 | 翻页 Token 用来标记当前开始读取的位置，置空表示从头开始 | 0f2cc944-67db-4fb1-bb10-f136cda74bda |
| MaxResults | integer | 否 | 分页数量 | 10 |
| Location | string | 否 | 地域 ID | cn-shanghai |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | 缺少必要的参数 |
| 400 | InvalidParameter | The specified parameter %s is invalid. | 无效的参数 |
| 400 | SignatureDoesNotMatch | The specified signature is invalid. | 签名认证错误 |
| 404 | InvalidUser.NotFound | The specified user is not found. | 找不到该用户信息，请先购买开通基因云产品 |
| 404 | InvalidPublicDataset.NotFound | The specified PublicDatasetName is not found. | 公共数据集名称不存在。 |
| 404 | InvalidOrderBy.NotFound | The specified OrderBy is not found. | 排序字段不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史