
# 受体口袋检测
#### 功能介绍
检测受体口袋，检测类型基于配体，基于氨基酸残基，自动检测，自定义和全局对接。
#### 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-eihealth/eihealth_33_0044.html)中获取。 最小长度：**1** 最大长度：**128** |
| eihealth_project_id | 是    | String | 平台项目ID。 最小长度：**1** 最大长度：**128**                                                                                   |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-eihealth/eihealth_33_0010.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                                                                        | 残基列表，当识别模式为残基时提供。 最小长度：**4** 最大长度：**16** 数组长度：**1 - 32**                                                                                                                                                                                                                                                                                                                                                                                                                  |
   
 表4ReceptorDrugFileReq 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| source       | 是    | String  | 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： - **EXTRANET**  - **PRIVATE**  - **PUBLIC**  - **RAW**   |
| url          | 否    | String  | 文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：**1** 最大长度：**2000**                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| format       | 否    | String  | 文件格式，仅支持PDB，仅数据源为RAW时提供。 最小长度：**1** 最大长度：**6**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| data         | 否    | String  | 文件原始数据，仅数据源为RAW时提供。 最小长度：**0** 最大长度：**10000000**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| add_hydrogen | 否    | Boolean | 增加氢原子。 缺省值：**true**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
   
 表5DrugFile 
| 参数     | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| source | 是    | String | 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： - **EXTRANET**  - **PRIVATE**  - **PUBLIC**  - **RAW**   |
| url    | 否    | String | 文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：**1** 最大长度：**2000**                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| format | 否    | String | 文件格式，支持PDB、SDF、MOL2、SMI，仅数据源为RAW时提供。 最小长度：**1** 最大长度：**6**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| data   | 否    | String | 文件原始数据，仅数据源为RAW时提供。 最小长度：**0** 最大长度：**10000000**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
#### 响应参数
**状态码： 200**
表6响应Body参数 
| 参数      | 参数类型                                                                                             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| mode    | String                                                                                           | 口袋识别的模式：自动、全局、配体、残基。 枚举值： - **AUTO**  - **GLOBAL**  - **LIGAND**  - **RESIDUES**   |
| pockets | Array of [DrugBoundingBoxDto] objects | 口袋列表。 数组长度：**1 - 10**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
 表7DrugBoundingBoxDto 
| 参数     | 参数类型            | 描述                                                                                                                                                                                                             |
|:---|:---|:---|
| center | Array of floats | 口袋中心坐标；x, y, z轴的坐标。 最小值：**-9999999** 最大值：**99999999** 数组长度：**3 - 3** |
| size   | Array of floats | 口袋尺寸大小；x, y, z轴的大小。 最小值：**2** 最大值：**500** 数组长度：**3 - 3**              |
   
#### 请求示例
```
{
  "mode" : "AUTO",
  "receptor_file" : {
    "source" : "EXTRANET",
    "url" : "https://files.rcsb.org/download/1TQN.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-eihealth/ErrorCode.html)。
