[B004]生物序列普通检索的接口地址是什么？

[B004]生物序列普通检索的接口为 POST https://connect.zhihuiya.com/bio-openapi/sequence/job。

[B004]生物序列普通检索可以返回哪些数据？

[B004]生物序列普通检索：根据关键信息检索生物序列。。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B004]生物序列普通检索的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1bio-openapi~1sequence~1job/post，也可在 /openapi.json 浏览完整规范。

[B004]生物序列普通检索

Q: [B004]生物序列普通检索 是什么？

根据关键信息检索生物序列。

Q: [B004]生物序列普通检索 的接口地址是什么？

[B004]生物序列普通检索 的接口为 POST https://connect.zhihuiya.com/bio-openapi/sequence/job。

post

https://connect.zhihuiya.com/bio-openapi/sequence/job

在体验中心中试用

根据关键信息检索生物序列。

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`database`	`array`	`[ "ALLPATENT" ]`	目标序列数据库，ALLPATENT（默认）：序列在专利标题/摘要/权利要求/说明书中公开；CLAIMS：序列在专利权利要求中公开；NONPATENT：序列在非专利文献中公开
`limit` 必填	`integer<int32>`	`1000`	返回的命中序列数量上限，最大支持10000
`params` 必填	`object`	`Please check the form: OpenApiBlastParameter`	序列比对参数
`algorithm` 必填	`string`	`blastn-short`	序列比对算法，核酸序列查询核酸序列用megablast，blastn或者blastn-short，核酸序列查询蛋白序列用blastx-fast，蛋白序列查询蛋白序列用blastp，blastp-fast或者blastp-short，蛋白序列查询核酸序列用tblastn-fast
`evalue`	`number<float>`	`100`	E-Value期望阈值设置越高，返回结果可能越多。E-Value代表命中结构与查询序列偶然相似的可能性。例如，如果查询序列很短，则其偶然出现在序列不同位置的可能性将很高。E-Value设置得越高，这种偶然性就越大。
`filter`	`object`	`Please check the form: OpenApiFilterParameter`	搜索过滤条件
`perc_identity`	`object`	`OpenApiBlastParameter`	匹配相似度过滤
`end`	`integer<int32>`	`100`	结束值
`start`	`integer<int32>`	-	开始值
`q_perc_identity`	`object`	`OpenApiBlastParameter`	查询序列匹配相似度过滤
`end`	`integer<int32>`	`100`	结束值
`start`	`integer<int32>`	-	开始值
`qcov_hsp_perc`	`object`	`OpenApiBlastParameter`	查询序列覆盖范围过滤
`end`	`integer<int32>`	`100`	结束值
`start`	`integer<int32>`	-	开始值
`s_perc_identity`	`object`	`OpenApiBlastParameter`	目标序列匹配相似度过滤
`end`	`integer<int32>`	`100`	结束值
`start`	`integer<int32>`	-	开始值
`scov_hsp_perc`	`object`	`OpenApiBlastParameter`	目标序列覆盖范围过滤
`end`	`integer<int32>`	`100`	结束值
`start`	`integer<int32>`	-	开始值
`subject_length`	`object`	`OpenApiBlastParameter`	目标序列长度过滤
`end`	`integer<int32>`	`100`	结束值
`start`	`integer<int32>`	-	开始值
`with_gaps`	`boolean`	-	设置是否包含间隙进行匹配意味着您是否希望序列对齐结果中包含间隙
`word_size`	`integer<int32>`	`4`	序列匹配步长。核酸搜核酸步长不得小于4，其他类型为2-7。步长越小，匹配越精确，相应的匹配时间也会越长。
`query_type` 必填	`string`	`NUCLEOTIDE`	目标序列类型，NUCLEOTIDE、PROTEIN
`sequence_list` 必填	`array`	`Please check the form: OpenApiRequestSequenceInfo`	查询序列，仅支持单条
`label`	`string`	`SEQ1`	用户输入的序列名称
`sequence`	`string`	`GGGAGGCTAAGGCAGGAG`	用户输入的序列
`sequence_type` 必填	`string`	`NUCLEOTIDE`	查询序列类型，NUCLEOTIDE、PROTEIN

请求示例

该 API 接口的请求体示例

JSON

{
  "limit": 1000,
  "params": {
    "evalue": 100,
    "filter": {
      "perc_identity": {
        "end": 100,
        "start": 0
      },
      "qcov_hsp_perc": {
        "end": 100,
        "start": 0
      },
      "scov_hsp_perc": {
        "end": 100,
        "start": 0
      },
      "subject_length": {
        "end": 100,
        "start": 0
      },
      "q_perc_identity": {
        "end": 100,
        "start": 0
      },
      "s_perc_identity": {
        "end": 100,
        "start": 0
      }
    },
    "algorithm": "blastn-short",
    "with_gaps": false,
    "word_size": 4
  },
  "database": [
    "ALLPATENT"
  ],
  "query_type": "NUCLEOTIDE",
  "sequence_list": [
    {
      "label": "SEQ1",
      "sequence": "GGGAGGCTAAGGCAGGAG"
    }
  ],
  "sequence_type": "NUCLEOTIDE"
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`array`	-	响应数据
`label`	`string`	`SEQ1`	用户输入的序列名称
`job_id`	`string`	`953a406a18d84dc8b13f0b923e406a43`	后台查询任务ID，使用此ID调用后续接口
`sequence`	`string`	`GGGAGGCTAAGGCAGGAG`	用户输入的序列
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": [
    {
      "label": "SEQ1",
      "job_id": "953a406a18d84dc8b13f0b923e406a43",
      "sequence": "GGGAGGCTAAGGCAGGAG"
    }
  ],
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码	描述
`68300004`	请求参数异常!
`68300005`	查询Api失败!
`68300006`	解析基本存取错误!
`68300007`	存在错误的请求!
`68300008`	服务中断异常，请稍后再试!
`68300010`	文件不符合上传规范!

平台错误码

错误码	描述
`67200000`	API整体限流错误!
`67200001`	API整体限流错误！
`67200002`	当前调用速率过快,超过当前配置限制QPS！
`67200003`	申请token的key和secret传参不正确或者客户端已被禁用！
`67200004`	请求的接口无权限请联系我们的支持人员！
`67200005`	账户余额/调用次数不足！
`67200006`	客户端超过开通有效期！
`67200007`	当前调用超过当天配置使用额度！
`67200008`	请检查query参数中必填的apikey是否传输！
`67200009`	apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
`67200012`	请求不合法！
`67200100`	当前服务器状态正忙,请求响应超时！
`67200101`	当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码	描述
`0`	请求成功
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`53000001`	请求参数异常。
`53000003`	服务器内部错误。

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms