GetPublicDatasetEntity - 查询公共数据集实体定义

查询平台公共数据集特定的实体定义。

调试

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

授权信息

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

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

请求参数

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

数据集名称

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

实体类型

sample
Locationstring

地域 ID

cn-shanghai

返回参数

名称类型描述示例值
object
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
RequestIdstring

请求 ID

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

公共数据集名称

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

实体类型

sample
Attributesarray

实体属性名称列表

string

实体属性

key
TotalCountinteger

该类型实体总数

100

示例

正常返回示例

JSON格式

{
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "DatasetName": "西蒙斯基因组多样性计划",
  "EntityType": "sample",
  "Attributes": [
    "key"
  ],
  "TotalCount": 100
}

错误码

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.公共数据集名称不存在。
404InvalidEntityType.NotFoundThe specified EntityType is not found.实体类型不存在

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

变更历史

变更时间变更内容概要操作
暂无变更历史