APISIX Control API (3.15.0)

Download OpenAPI specification:Download

APISIX Control API 用于获取 APISIX 的内部状态。除了下面列出的端点外，某些插件（例如 server-info）可以向控制 API 添加额外的端点。

Schema

Schema 定义了可用的参数及其数据类型、属性、默认值、有效值等。

获取 JSON Schema

获取 APISIX 实例使用的 JSON schema。

Responses

Response samples

200
400

Content type

application/json

{"1": {"summary": "成功示例",
"value": {"value": {"main": {"route": {"properties": { }
},
"upstream": {"properties": { }
}
},
"plugins": {"example-plugin": {"consumer_schema": { },
"metadata_schema": { },
"schema": { },
"type": "object",
"priority": 0,
"version": 0.1
}
},
"stream-plugins": {"mqtt-proxy": { }
}
}
}
}
}

健康检查

健康检查是一种机制，根据上游服务的响应能力来确定它们是健康还是不健康。

获取健康检查信息

获取 APISIX 实例的健康检查信息。你需要向路由发起请求以生成控制 API 健康检查信息。

Responses

Response samples

200

Content type

application/json

Example

成功示例

{"nodes": [{"ip": "52.86.68.46",
"counter": {"http_failure": 0,
"success": 0,
"timeout_failure": 0,
"tcp_failure": 0
},
"port": 80,
"status": "健康"
},
{"ip": "100.24.156.8",
"counter": {"http_failure": 5,
"success": 0,
"timeout_failure": 0,
"tcp_failure": 0
},
"port": 80,
"status": "不健康"
}
],
"name": "/apisix/routes/1",
"type": "http"
}

按类型和 ID 获取健康状态

获取指定资源的健康状态。

path Parameters

src_type required	string Enum: "routes" "services" "upstreams" 指定的资源类型。
src_id required	string 指定的节点 ID。

Responses

Response samples

200
400
404

Content type

application/json

{"nodes": [{"ip": "52.86.68.46",
"counter": {"http_failure": 0,
"success": 2,
"timeout_failure": 0,
"tcp_failure": 0
},
"port": 80,
"status": "健康"
},
{"ip": "100.24.156.8",
"counter": {"http_failure": 5,
"success": 0,
"timeout_failure": 0,
"tcp_failure": 0
},
"port": 80,
"status": "不健康"
}
],
"type": "http",
"name": "/apisix/routes/1"
}

垃圾回收

垃圾回收是一种自动内存管理形式。垃圾回收器尝试回收程序已分配但不再被引用的内存。

触发垃圾回收

在 HTTP 子系统中触发一次完整的垃圾回收。请注意，对此端点的请求不会在 stream 子系统中触发垃圾回收，因为这些子系统在单独的 Lua VM 中运行。

Responses

Response samples

200

Content type

application/json

{ }

路由

路由定义了一条指向一个或多个上游服务的路径。

有关详细信息，请参阅路由。

获取所有路由

获取所有已配置的路由。

Responses

Response samples

200

Content type

application/json

{"priority": 0,
"uris": ["/hello"
],
"id": "1",
"upstream": {"scheme": "http",
"pass_host": "pass",
"nodes": [{"port": 1980,
"host": "127.0.0.1",
"weight": 1
}
],
"type": "roundrobin",
"hash_on": "vars"
},
"status": 1
}

按 ID 获取路由

按 ID 获取路由。

path Parameters

id

required

string

指定的路由 ID。

Responses

Response samples

200
404

Content type

application/json

{"priority": 0,
"uris": ["/hello"
],
"id": "1",
"upstream": {"scheme": "http",
"pass_host": "pass",
"nodes": [{"port": 1980,
"host": "127.0.0.1",
"weight": 1
}
],
"type": "roundrobin",
"hash_on": "vars"
},
"status": 1
}

上游

上游是一个或多个上游地址的逻辑抽象。

有关详细信息，请参阅上游。

获取所有上游

获取所有已配置的上游。

Responses

Response samples

200

Content type

application/json

{"scheme": "http",
"pass_host": "pass",
"nodes": [{"host": "127.0.0.1",
"port": 80,
"weight": 1
},
{"host": "foo.com",
"port": 80,
"weight": 2
}
],
"hash_on": "vars",
"update_time": 1634543819,
"key": "remote_addr",
"create_time": 1634539759,
"id": "1",
"type": "chash"
}

按 ID 获取上游

按 ID 获取上游。

path Parameters

id

required

string

指定的上游 ID。

Responses

Response samples

200
404

Content type

application/json

{"scheme": "http",
"pass_host": "pass",
"nodes": [{"host": "127.0.0.1",
"port": 80,
"weight": 1
},
{"host": "foo.com",
"port": 80,
"weight": 2
}
],
"hash_on": "vars",
"update_time": 1634543819,
"key": "remote_addr",
"create_time": 1634539759,
"id": "1",
"type": "chash"
}

服务

服务是提供一组功能的后端应用程序。

有关详细信息，请参阅服务。

获取所有服务

获取所有已配置的服务。

Responses

Response samples

200

Content type

application/json

{"has_domain": false,
"clean_handlers": { },
"modifiedIndex": 671,
"key": "/apisix/services/200",
"createdIndex": 671,
"value": {"upstream": {"scheme": "http",
"hash_on": "vars",
"pass_host": "pass",
"type": "roundrobin",
"nodes": [{"port": 1980,
"weight": 1,
"host": "127.0.0.1"
}
]
},
"create_time": 1634552648,
"id": "200",
"plugins": {"limit-count": {"key": "remote_addr",
"time_window": 60,
"redis_timeout": 1000,
"allow_degradation": false,
"show_limit_quota_header": true,
"policy": "local",
"count": 2,
"rejected_code": 503
}
},
"update_time": 1634552648
}
}

按 ID 获取服务

按 ID 获取服务。

path Parameters

id

required

string

指定的服务 ID。

Responses

Response samples

200
404

Content type

application/json

{"has_domain": false,
"clean_handlers": { },
"modifiedIndex": 728,
"key": "/apisix/services/5",
"createdIndex": 728,
"value": {"create_time": 1634554563,
"id": "5",
"upstream": {"scheme": "http",
"hash_on": "vars",
"pass_host": "pass",
"type": "roundrobin",
"nodes": [{"port": 1980,
"weight": 1,
"host": "127.0.0.1"
}
]
},
"update_time": 1634554563
}
}

插件元数据

插件元数据用于配置共享同一插件名称的所有插件实例的公共元数据字段。有关详细信息，请参阅插件元数据。

获取所有插件元数据

获取所有插件元数据。

Responses

Response samples

200

Content type

application/json

[{"log_format": {"upstream_response_time": "$upstream_response_time"
},
"id": "file-logger"
},
{"ikey": 1,
"skey": "val",
"id": "example-plugin"
}
]

按名称获取插件元数据

按插件名称获取插件元数据。

path Parameters

plugin_name

required

string

指定的插件名称。

Responses

Response samples

200
404

Content type

application/json

{"log_format": {"upstream_response_time": "$upstream_response_time"
},
"id": "file-logger"
}

插件

插件扩展了 APISIX 的基础功能以满足用户的特定需求。

有关详细信息，请参阅插件。

重新加载所有插件

热重新加载插件，使配置文件中的插件列表或插件源文件的更改生效。

Responses

Response samples

200

Content type

application/json

"完成"

服务发现

服务发现是在基于微服务的架构中使用的一种过程，用于自动检测和注册动态分配的上游地址。

有关详细信息，请参阅服务发现。

获取内存转储

获取服务和配置详细信息。

Responses

Response samples

200
404

Content type

application/json

{"services": {"svc-a": [{"host": "192.168.42.145",
"weight": 1,
"port": 9081
},
{"host": "192.168.42.145",
"weight": 1,
"port": 9082
}
]
},
"config": {"dump": {"load_on_init": true,
"expire": 2592000,
"path": "logs/consul.dump"
},
"timeout": {"wait": 60,
"read": 2000,
"connect": 2000
},
"fetch_interval": 3,
"keepalive": true,
"weight": 1,
"servers": ["http://consul:8500"
],
"token": ""
}
}

获取转储文件

获取已配置的服务详细信息。

Responses

Response samples

200
404
503

Content type

application/json

{"last_update": 1703594980,
"services": {"svc-a": [{"host": "192.168.42.145",
"weight": 1,
"port": 9081
},
{"host": "192.168.42.145",
"weight": 1,
"port": 9082
}
]
},
"expire": 2592000
}