
# 受体口袋检测 - RecognizeDrugReceptorPocket
#### 功能介绍
检测受体口袋，检测类型基于配体，基于氨基酸残基，自动检测，自定义和全局对接。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。
#### URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/pocket
表1路径参数 
| 参数                  | 是否必选 | 参数类型   | 描述                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id          | 是    | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 |
| eihealth_project_id | 是    | String | **参数解释**： 空间ID，您可以从[获取空间ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0099.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**： 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0011.html)接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-32768\]个字符。 **默认取值**： 不涉及 |
   
表3请求Body参数 
| 参数            | 是否必选 | 参数类型                                                                                    | 描述                                                                                                       |
|:---|:---|:---|:---|
| mode          | 是    | String                                                                                  | **参数解释**： 口袋识别的模式。 **约束限制**： 不涉及 **取值范围**： - AUTO：自动 - GLOBAL：全局 - LIGAND：配体 - RESIDUES：残基 **默认取值**： 不涉及 |
| receptor_file | 是    | [ReceptorDrugFileReq] object | **参数解释**： 受体文件。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                                                |
| ligand_file   | 否    | [DrugFile] object                       | **参数解释**： 配体文件。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                                                |
| residues      | 否    | Array of strings                                                                        | **参数解释**： 残基列表。 **约束限制**： 当识别模式为残基时提供，残基数量范围为\[1-32\]，残基长度为\[4-16\]个字符。 **取值范围**： 不涉及 **默认取值**： 不涉及      |
   
 表4ReceptorDrugFileReq 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                           |
|:---|:---|:---|:---|
| source       | 是    | String  | **参数解释**： 受体数据源。 **约束限制**： 不涉及 **取值范围**： - EXTRANET：外部网络数据 - PRIVATE：私有数据 - PUBLIC：公共数据 - RAW：源数据 **默认取值**： 不涉及                              |
| url          | 否    | String  | **参数解释**： 文件URL。 **约束限制**： 当数据源source为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址。 **取值范围**： 文件URL需以pdb结尾，长度为\[1-2000\]个字符。 **默认取值**： 不涉及 |
| format       | 否    | String  | **参数解释**： 文件格式。 **约束限制**： 当数据源source为RAW时提供。 **取值范围**： 仅支持PDB。 **默认取值**： 不涉及                                                                 |
| data         | 否    | String  | **参数解释**： 文件原始数据。 **约束限制**： 当数据源source为RAW时提供。 **取值范围**： 长度为\[0-10000000\]个字符。 **默认取值**： 不涉及                                                 |
| add_hydrogen | 否    | Boolean | **参数解释**： 是否增加氢原子。 **约束限制**： 不涉及 **取值范围**： - true：增加氢原子 - false：不增加氢原子 **默认取值**： true                                                        |
   
 表5DrugFile 
| 参数     | 是否必选 | 参数类型   | 描述                                                                                                                                                               |
|:---|:---|:---|:---|
| source | 是    | String | **参数解释**： 受体数据源。 **约束限制**： 不涉及 **取值范围**： - EXTRANET：外部网络数据 - PRIVATE：私有数据 - PUBLIC：公共数据 - RAW：源数据 **默认取值**： 不涉及                                                  |
| url    | 否    | String | **参数解释**： 文件URL。 **约束限制**： 当数据源source为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址 **取值范围**： 文件仅URL仅支持以.pdb、.mol2、.sdf、.smi为结尾，长度为\[1-2000\]个字符。 **默认取值**： 不涉及 |
| format | 否    | String | **参数解释**： 文件格式。 **约束限制**： 当数据源source为RAW时提供。 **取值范围**： - PDB：PDB文件 - SDF：SDF文件 - MOL2：MOL2文件 - SMI：SMI文件 **默认取值**： 不涉及                                           |
| data   | 否    | String | **参数解释**： 文件原始数据。 **约束限制**： 当数据源source为RAW时提供。 **取值范围**： 长度为\[0-10000000\]个字符。 **默认取值**： 不涉及                                                                     |
   
#### 响应参数
**状态码：200**
表6响应Body参数 
| 参数      | 参数类型                                                                                             | 描述                                                                                                       |
|:---|:---|:---|
| mode    | String                                                                                           | **参数解释**： 口袋识别的模式。 **约束限制**： 不涉及 **取值范围**： - AUTO：自动 - GLOBAL：全局 - LIGAND：配体 - RESIDUES：残基 **默认取值**： 不涉及 |
| pockets | Array of [DrugBoundingBoxDto] objects | **参数解释**： 口袋列表。 **约束限制**： 口袋数量范围为\[1-10\]。 **取值范围**： 不涉及 **默认取值**： 不涉及                                   |
   
 表7DrugBoundingBoxDto 
| 参数     | 参数类型             | 描述                                                                                                           |
|:---|:---|:---|
| center | Array of doubles | **参数解释**： 口袋中心坐标，x、y、z轴的坐标。 **约束限制**： 数组长度固定为3，数组元素大小取值范围为\[-9999999-99999999\]。 **取值范围**： 不涉及 **默认取值**： 不涉及 |
| size   | Array of floats  | **参数解释**： 口袋尺寸大小，x、y、z轴的大小。 **约束限制**： 数组长度固定为3，数组元素大小取值范围为\[2-500\]。 **取值范围**： 不涉及 **默认取值**： 不涉及             |
   
#### 请求示例
受体口袋识别，识别模式为AUTO，受体文件为test.pdb。
```
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/pocket
{
  "mode" : "AUTO",
  "receptor_file" : {
    "source" : "PRIVATE",
    "url" : "project:/test.pdb"
  }
}
```
#### 响应示例
**状态码：200**
受体口袋检测成功响应。
```
{
  "mode" : "AUTO",
  "pockets" : [ {
    "center" : [ 39.067, 26.472, 51.635 ],
    "size" : [ 6.668, 8.465, 6.582 ]
  }, {
    "center" : [ 29.013, 37.992, 54.6 ],
    "size" : [ 3.468, 2.754, 5.233 ]
  }, {
    "center" : [ 34.946, 18.73, 45.517 ],
    "size" : [ 5.178, 6.133, 5.156 ]
  }, {
    "center" : [ 32.901, 33.444, 61.459 ],
    "size" : [ 3.664, 4.93, 3.59 ]
  }, {
    "center" : [ 53.883, 17.701, 48.675 ],
    "size" : [ 3.281, 2, 10.053 ]
  }, {
    "center" : [ 47.861, 17.39, 37.703 ],
    "size" : [ 5.231, 2, 3.53 ]
  } ]
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 受体口袋检测成功响应。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。
