kayx23 commented on code in PR #12200: URL: https://github.com/apache/apisix/pull/12200#discussion_r2099417227
########## docs/zh/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +在 Apache APISIX 中，状态 API 用于： + +* 检查 APISIX 是否已成功启动并正确运行 +* 检查所有工作人员是否已收到并加载配置。 + +要更改 Status API 服务器的默认端点（`127.0.0.1:7085`），请更改配置文件（`conf/config.yaml`）中 `status` 部分中的 `ip` 和 `port`： + +```yaml +apisix: + status: + ip: "127.0.0.1" + port: 7085 +``` + +此 API 可用于在 APISIX 开始接收用户请求之前对 APISIX 执行就绪探测。 + +### GET /status + +返回报告 APISIX 工作者状态的 JSON + +```json +{ + "status": "ok" +} +``` + +### GET /status/ready + +当所有 Worker 都已加载配置时，返回 `ok`；否则，返回特定错误，错误代码为 `503`。以下是具体示例。 + +当所有 Worker 都已加载配置时 Review Comment: <img width="608" alt="image" src="https://github.com/user-attachments/assets/b63dddce-bad3-42cb-bc45-d99a667c7aa3"; /> lower case the `Worker`, thanks ########## docs/zh/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +在 Apache APISIX 中，状态 API 用于： Review Comment: ```suggestion 在 Apache APISIX 中，Status API 用于： ``` ########## docs/en/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +In Apache APISIX, the status API is used to: + +* Check if APISIX has successfully started and running correctly. +* Check if all of the workers have received and loaded the configuration. + +To change the default endpoint (`127.0.0.1:7085`) of the Status API server, change the `ip` and `port` in the `status` section in your configuration file (`conf/config.yaml`): + +```yaml +apisix: + status: + ip: "127.0.0.1" + port: 7085 +``` + +This API can be used to perform readiness probes on APISIX before APISIX starts receiving user requests. + +### GET /status + +Returns a JSON reporting the status of APISIX workers + +```json +{ + "status": "ok" +} +``` + +### GET /status/ready + +Returns `ok` when all workers have loaded the configuration, otherwise returns the specific error with `503` error code. Below are specific examples. + +When all workers have loaded the configuration Review Comment: ```suggestion When all workers have loaded the configuration: ``` Please do the same for other sentences missing punctuation in this doc. ########## docs/zh/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +在 Apache APISIX 中，状态 API 用于： + +* 检查 APISIX 是否已成功启动并正确运行 +* 检查所有工作人员是否已收到并加载配置。 + +要更改 Status API 服务器的默认端点（`127.0.0.1:7085`），请更改配置文件（`conf/config.yaml`）中 `status` 部分中的 `ip` 和 `port`： + +```yaml +apisix: + status: + ip: "127.0.0.1" + port: 7085 +``` + +此 API 可用于在 APISIX 开始接收用户请求之前对 APISIX 执行就绪探测。 + +### GET /status + +返回报告 APISIX 工作者状态的 JSON + +```json +{ + "status": "ok" +} +``` + +### GET /status/ready + +当所有 Worker 都已加载配置时，返回 `ok`；否则，返回特定错误，错误代码为 `503`。以下是具体示例。 + +当所有 Worker 都已加载配置时 + +```json +{ + "status": "ok" +} +``` + +当 1 个 workers 尚未初始化时 + +```json +{ + "status": "error", + "error": "worker count: 16 but status report count: 15" +} +``` + +当特定工作器尚未加载配置时 Review Comment: ```suggestion 当特定 worker 尚未加载配置时： ``` ########## docs/zh/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +在 Apache APISIX 中，状态 API 用于： + +* 检查 APISIX 是否已成功启动并正确运行 +* 检查所有工作人员是否已收到并加载配置。 Review Comment: ```suggestion * 检查所有 workers 是否已收到配置并加载。 ``` ########## docs/en/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +In Apache APISIX, the status API is used to: + +* Check if APISIX has successfully started and running correctly. +* Check if all of the workers have received and loaded the configuration. + +To change the default endpoint (`127.0.0.1:7085`) of the Status API server, change the `ip` and `port` in the `status` section in your configuration file (`conf/config.yaml`): + +```yaml +apisix: + status: + ip: "127.0.0.1" + port: 7085 +``` + +This API can be used to perform readiness probes on APISIX before APISIX starts receiving user requests. + +### GET /status + +Returns a JSON reporting the status of APISIX workers + +```json +{ + "status": "ok" Review Comment: What if the status is not ok? The section below shows output when its "not ok" - what about this section? ########## docs/zh/latest/status-api.md: ########## @@ -0,0 +1,78 @@ +--- +title: Status API +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +在 Apache APISIX 中，状态 API 用于： + +* 检查 APISIX 是否已成功启动并正确运行 +* 检查所有工作人员是否已收到并加载配置。 + +要更改 Status API 服务器的默认端点（`127.0.0.1:7085`），请更改配置文件（`conf/config.yaml`）中 `status` 部分中的 `ip` 和 `port`： + +```yaml +apisix: + status: + ip: "127.0.0.1" + port: 7085 +``` + +此 API 可用于在 APISIX 开始接收用户请求之前对 APISIX 执行就绪探测。 + +### GET /status + +返回报告 APISIX 工作者状态的 JSON Review Comment: ```suggestion 返回报告 APISIX worker 状态的 JSON： ``` similarly add missing punctuation in this doc -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
