查询API运行时定义

功能介绍

查看指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。

API的定义分为临时定义和运行时定义，分别代表如下含义：

• 临时定义：API在编辑中的定义，表示用户最后一次编辑后的API的状态
• 运行时定义：API在发布到某个环境时，对发布时的API的临时定义进行快照，固化出来的API的状态。

访问某个环境上的API，其实访问的就是其运行时的定义

URI

HTTP/HTTPS请求方法以及URI如下表所示。

• 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
• 查询条件可为以下字段以及对应的值：env_id。

URI中的参数说明如下表所示。

请求消息

响应消息

响应消息样例：

{
  "name": "market_api01",
  "type": 1,
  "version": "V0.0.1",
  "req_protocol": "HTTPS",
  "req_method": "GET",
  "req_uri": "/test01",
  "auth_type": "APP",
  "auth_opt": {
    "app_code_auth_type": "HEADER"
  },
  "tags": ["APIG-SN-test", "test"],
  "cors": true,
  "match_mode": "NORMAL",
  "backend_type": "MOCK",
  "remark": "market_api01",
  "group_id": "7f848adc971749cda9c6aff3877cfc3e",
  "body_remark": "market_api01",
  "result_normal_sample": "success",
  "result_failure_sample": "",
  "id": "0e51b689e0784bc884f43756bbf34fa5",
  "group_name": "market_group01",
  "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "run_env_name": "RELEASE",
  "publish_id": "f07eb9f5e5ba4bbfbe89326f5cae99c7",
  "sl_domain": "61297835ff1e4905b6f635dbcdf1777e.apigw.example.com",
  "sl_domains": ["61297835ff1e4905b6f635dbcdf1777e.apigw.example.com", "61297835ff1e4905b6f635dbcdf1777e.apigw.example.cn"],
  "req_params": [
    {
      "name": "project_id",
      "type": "STRING",
      "location": "PATH",
      "default_value": "",
      "sample_value": "",
      "required": 1,
      "valid_enable": 2,
      "remark": "",
      "enumerations": "",
      "min_num": 0,
      "max_num": 0,
      "min_size": 0,
      "max_size": 0,
      "regular": "",
      "json_schema": "",
      "id": "2a61905ea2304186a9422faba2940735"
    }
  ]
}

状态码