From 5bfc8978b4c43d5f3a06c793aa0f602f06120a01 Mon Sep 17 00:00:00 2001 From: songzxc789 Date: Thu, 22 Aug 2024 17:42:58 +0800 Subject: [PATCH] =?UTF-8?q?Docs=20improvements=EF=BC=9Aget=20deploy=20phas?= =?UTF-8?q?es=20,=20list=20processes=20(#1557)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../api_doc/en/get_deploy_phases_framework.md | 200 +++++++++---- .../api_doc/en/get_deploy_phases_instance.md | 264 ++++++++++++++---- .../apigw/api_doc/en/list_processes.md | 206 +++++++++++--- .../apigw/api_doc/en/search_structured_log.md | 4 +- .../en/search_structured_log_with_post.md | 6 +- .../en/upload_source_package_via_link.md | 2 +- .../api_doc/zh/get_deploy_phases_framework.md | 193 +++++++++---- .../api_doc/zh/get_deploy_phases_instance.md | 258 +++++++++++++---- .../apigw/api_doc/zh/list_processes.md | 204 +++++++++++--- .../apigw/api_doc/zh/search_structured_log.md | 4 +- .../zh/search_structured_log_with_post.md | 4 +- .../zh/upload_source_package_via_link.md | 4 +- 12 files changed, 1059 insertions(+), 290 deletions(-) diff --git a/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_framework.md b/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_framework.md index 96331cf478..ecec60240a 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_framework.md +++ b/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_framework.md @@ -21,63 +21,159 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"bk_app_code": "***", "bk_app_secret": " ### Response Example ```json -[{ - "display_name": "Preparation Phase", +[ + { + "display_name": "Preparation Stage", "type": "preparation", - "steps": [{ - "name": "Parse application process information", - "display_name": "Parse application process information" - }, { - "name": "Upload repository code", - "display_name": "Upload repository code" - }, { - "name": "Configure resource instance", - "display_name": "Configure resource instance" - }] + "steps": [ + { + "name": "Parse Application Process Information", + "display_name": "Parse Application Process Information", + "skipped": false + }, + { + "name": "Upload Repository Code", + "display_name": "Upload Repository Code", + "skipped": false + }, + { + "name": "Configure Resource Instances", + "display_name": "Configure Resource Instances", + "skipped": false + } + ], + "display_blocks": { + "source_info": { + "source_type": "", + "type": "", + "trunk_url": null, + "repo_url": null, + "source_dir": "", + "repo_fullname": null, + "diff_feature": {}, + "linked_to_internal_svn": false, + "display_name": "" + }, + "services_info": [ + { + "name": "mysql", + "display_name": "MySQL", + "is_provisioned": true, + "service_id": "c8aa4ce5-f5f2-45ef-b6be-d06a0ce703eb", + "category_id": 1 + } + ], + "prepare_help_docs": [ + { + "title": "Introduction to Application Process Concepts and How to Use", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "A brief introduction to application processes, including content on Procfile", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "Introduction to Application Process Concepts and How to Use", + "text": "Introduction to Application Process Concepts and How to Use", + "description": "A brief introduction to application processes, including content on Procfile" + } + ] + } }, { - "display_name": "Build Phase", + "display_name": "Build Stage", "type": "build", - "steps": [{ - "name": "Initialize build environment", - "display_name": "Initialize build environment" - }, { - "name": "Detect build tools", - "display_name": "Detect build tools" - }, { - "name": "Analyze build scheme", - "display_name": "Analyze build scheme" - }, { - "name": "Call pre-compile", - "display_name": "Call pre-compile" - }, { - "name": "Build application", - "display_name": "Build application" - }, { - "name": "Call post-compile", - "display_name": "Call post-compile" - }, { - "name": "Generate build results", - "display_name": "Generate build results" - }, { - "name": "Clean up build environment", - "display_name": "Clean up build environment" - }] + "steps": [ + { + "name": "Initialize Build Environment", + "display_name": "Initialize Build Environment", + "skipped": false + }, + { + "name": "Analyze Build Plan", + "display_name": "Analyze Build Plan", + "skipped": false + }, + { + "name": "Check Build Tools", + "display_name": "Check Build Tools", + "skipped": false + }, + { + "name": "Build Application", + "display_name": "Build Application", + "skipped": false + }, + { + "name": "Upload Image", + "display_name": "Upload Image", + "skipped": false + } + ], + "display_blocks": { + "runtime_info": { + "image": "BlueKing Base Image", + "slugbuilder": null, + "slugrunner": null, + "buildpacks": [ + { + "id": 2, + "language": "Python", + "name": "bk-buildpack-python", + "display_name": "Python", + "description": "The default Python version is 3.10.5" + } + ] + }, + "build_help_docs": [ + { + "title": "How to Use Pre-Deployment Commands", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "How to Use Pre-Deployment Commands", + "text": "How to Use Pre-Deployment Commands", + "description": "" + } + ] + } }, { - "display_name": "Deployment Phase", + "display_name": "Release Stage", "type": "release", - "steps": [{ - "name": "Execute pre-deployment command", - "display_name": "Execute pre-deployment command" - }, { - "name": "Deploy application", - "display_name": "Deploy application" - }, { - "name": "Detect deployment result", - "display_name": "Detect deployment result" - }] - }] + "steps": [ + { + "name": "Deploy Application", + "display_name": "Deploy Application", + "skipped": false + }, + { + "name": "Execute Pre-Deployment Commands", + "display_name": "Execute Pre-Deployment Commands", + "skipped": false + }, + { + "name": "Check Deployment Results", + "display_name": "Check Deployment Results", + "skipped": false + } + ], + "display_blocks": { + "access_info": { + "address": "http://apps.example.com/example", + "type": "subpath" + }, + "release_help_docs": [ + { + "title": "Configure BlueKing Application Access Entry", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "Configure BlueKing Application Access Entry", + "text": "Configure BlueKing Application Access Entry", + "description": "" + } + ] + } + } +] + ``` ### Response Parameter Description @@ -88,9 +184,11 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"bk_app_code": "***", "bk_app_secret": " | display_name | string | Display name of the current phase (changes with i18n) | | type | string | Type of the current phase (can be used as an identifier) | | steps | List | Steps included in the current phase | +| display_blocks | object | Display blocks of the current phase | #### Step Object Field Description | Parameter Name | Parameter Type | Description | |--------------------|--------------------|---------------------| | display_name | string | Display name of the current phase (changes with i18n) | -| name | string | Unique name of the current phase | \ No newline at end of file +| name | string | Unique name of the current phase | +| skipped | bool | whether skipped this step | \ No newline at end of file diff --git a/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_instance.md b/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_instance.md index 8fc1d4e09c..55805ff853 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_instance.md +++ b/apiserver/paasng/support-files/apigw/api_doc/en/get_deploy_phases_instance.md @@ -22,63 +22,215 @@ None. ### Response Result Example ```json -[{ - "display_name": "Preparation Phase", +[ + { + "display_name": "Preparation Stage", "type": "preparation", - "steps": [{ - "name": "Parse application process information", - "display_name": "Parse application process information" - }, { - "name": "Upload repository code", - "display_name": "Upload repository code" - }, { - "name": "Configure resource instance", - "display_name": "Configure resource instance" - }] + "steps": [ + { + "name": "Parse Application Process Information", + "display_name": "Parse Application Process Information", + "skipped": false, + "uuid": "34dace83-6fc0-486b-8a20-1a62b7c2a110", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:33" + }, + { + "name": "Upload Repository Code", + "display_name": "Upload Repository Code", + "skipped": false, + "uuid": "1a191578-0b9f-4961-8fef-83cfeb3e9421", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "Configure Resource Instances", + "display_name": "Configure Resource Instances", + "skipped": false, + "uuid": "a346504a-b7d6-4c4b-8db2-537e8f43d87d", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:33" + } + ], + "display_blocks": { + "source_info": { + "source_type": "", + "type": "", + "trunk_url": null, + "repo_url": null, + "source_dir": "", + "repo_fullname": null, + "diff_feature": {}, + "linked_to_internal_svn": false, + "display_name": "" + }, + "services_info": [ + { + "name": "mysql", + "display_name": "MySQL", + "is_provisioned": true, + "service_id": "c8aa4ce5-f5f2-45ef-b6be-d06a0ce703eb", + "category_id": 1 + } + ], + "prepare_help_docs": [ + { + "title": "Introduction to Application Process Concepts and How to Use", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "A brief introduction to application processes, including content on Procfile", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "Introduction to Application Process Concepts and How to Use", + "text": "Introduction to Application Process Concepts and How to Use", + "description": "A brief introduction to application processes, including content on Procfile" + } + ] + }, + "uuid": "9094bfb2-14ab-41bc-a3bc-1794a2c5115d", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:33" }, { - "display_name": "Build Phase", + "display_name": "Build Stage", "type": "build", - "steps": [{ - "name": "Initialize build environment", - "display_name": "Initialize build environment" - }, { - "name": "Detect build tools", - "display_name": "Detect build tools" - }, { - "name": "Analyze build scheme", - "display_name": "Analyze build scheme" - }, { - "name": "Call pre-compile", - "display_name": "Call pre-compile" - }, { - "name": "Build application", - "display_name": "Build application" - }, { - "name": "Call post-compile", - "display_name": "Call post-compile" - }, { - "name": "Generate build result", - "display_name": "Generate build result" - }, { - "name": "Clean up build environment", - "display_name": "Clean up build environment" - }] + "steps": [ + { + "name": "Initialize Build Environment", + "display_name": "Initialize Build Environment", + "skipped": false, + "uuid": "c6220ae7-95e4-4ad8-9ccb-f7cd09689028", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "Analyze Build Plan", + "display_name": "Analyze Build Plan", + "skipped": false, + "uuid": "ae9c4785-5e89-4b65-977d-4180c77ca82b", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "Check Build Tools", + "display_name": "Check Build Tools", + "skipped": false, + "uuid": "0ef1f2e3-3d90-496e-ab56-a24ece3613a8", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "Build Application", + "display_name": "Build Application", + "skipped": false, + "uuid": "bc9b3bd5-fc2c-4b33-9a14-dba4b14791f9", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "Upload Image", + "display_name": "Upload Image", + "skipped": false, + "uuid": "aefa4786-87af-46c4-8fc5-dc733001dad8", + "status": null, + "start_time": null, + "complete_time": null + } + ], + "display_blocks": { + "runtime_info": { + "image": "BlueKing Base Image", + "slugbuilder": null, + "slugrunner": null, + "buildpacks": [ + { + "id": 2, + "language": "Python", + "name": "bk-buildpack-python", + "display_name": "Python", + "description": "The default Python version is 3.10.5" + } + ] + }, + "build_help_docs": [ + { + "title": "How to Use Pre-Deployment Commands", + "location": "http://apps.example.com/bk--docs--center/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/", + "name": "How to Use Pre-Deployment Commands", + "text": "How to Use Pre-Deployment Commands", + "description": "" + } + ] + }, + "uuid": "51d9e97f-da21-42dc-a24d-0d20286d9ee5", + "status": null, + "start_time": null, + "complete_time": null }, { - "display_name": "Deployment Phase", + "display_name": "Release Stage", "type": "release", - "steps": [{ - "name": "Execute pre-deployment command", - "display_name": "Execute pre-deployment command" - }, { - "name": "Deploy application", - "display_name": "Deploy application" - }, { - "name": "Detect deployment result", - "display_name": "Detect deployment result" - }] - }] + "steps": [ + { + "name": "Deploy Application", + "display_name": "Deploy Application", + "skipped": false, + "uuid": "223b64c0-0c6b-478e-a839-3339d75b2838", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:34" + }, + { + "name": "Execute Pre-Deployment Commands", + "display_name": "Execute Pre-Deployment Commands", + "skipped": false, + "uuid": "3a9e3144-f300-46f2-90c3-1b2f4097bff1", + "status": "successful", + "start_time": "2024-08-16 10:07:34", + "complete_time": "2024-08-16 10:07:55" + }, + { + "name": "Check Deployment Results", + "display_name": "Check Deployment Results", + "skipped": false, + "uuid": "3f7e961d-fbb7-4c43-952a-3826513ca426", + "status": "successful", + "start_time": "2024-08-16 10:07:34", + "complete_time": "2024-08-16 10:08:07" + } + ], + "display_blocks": { + "access_info": { + "address": "http://apps.example.com/bk--notice/", + "type": "subpath" + }, + "release_help_docs": [ + { + "title": "Configure BlueKing Application Access Entry", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/markdown/PaaS/", + "name": "Configure BlueKing Application Access Entry", + "text": "Configure BlueKing Application Access Entry", + "description": "" + } + ] + }, + "uuid": "4dbe12b7-7a19-4a31-9a21-a080c6e71a08", + "status": "successful", + "start_time": "2024-08-16 10:08:07", + "complete_time": "2024-08-16 10:08:07" + } +] + ``` ### Response Result Parameter Description @@ -89,9 +241,19 @@ None. | display_name | string | Display name of the current phase (changes with i18n) | | type | string | Type of the current phase (can be used as an identifier) | | steps | List | Steps included in the current phase | +| display_blocks | object | Display blocks of the current phase | +| uuid | string | UUID | +| status | string | Status | +| start_time| string | Start time | +| complete_time | string | Complete time | #### Step Object Field Description | Parameter Name | Parameter Type | Parameter Description | |--------------------|--------------------|-------------------------------| | display_name | string | Display name of the current step (changes with i18n) | -| name | string | Unique name of the current step | \ No newline at end of file +| name | string | Unique name of the current step | +| skipped | bool | Whether skipped this step | +| uuid | string | UUID | +| status | string | Status | +| start_time| string | Start time | +| complete_time | string | Complete time | \ No newline at end of file diff --git a/apiserver/paasng/support-files/apigw/api_doc/en/list_processes.md b/apiserver/paasng/support-files/apigw/api_doc/en/list_processes.md index 6337f2a059..22c6ed6bdd 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/en/list_processes.md +++ b/apiserver/paasng/support-files/apigw/api_doc/en/list_processes.md @@ -22,47 +22,171 @@ curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app ``` ### Response Result Example -Status: OK + +```json +{ + "processes": { + "items": [ + { + "module_name": "default", + "name": "example--web", + "type": "web", + "command": "", + "replicas": 5, + "success": 5, + "failed": 0, + "version": 175, + "cluster_link": "http://example--web.bkapp-example-prod" + } + ], + "extra_infos": [ + { + "type": "web", + "command": "", + "cluster_link": "http://example--web.bkapp-example-prod" + } + ], + "metadata": { + "resource_version": "192437966" + } + }, + "instances": { + "items": [ + { + "module_name": "default", + "name": "example--web-699599bf76-78jzf", + "process_type": "web", + "display_name": "78jzf", + "image": "docker.example.com/bkpaas/docker/example/default:1.5.5", + "start_time": "2024-08-16T02:07:55Z", + "state": "Running", + "state_message": null, + "rich_status": "Running", + "ready": true, + "restart_count": 0, + "version": "175" + } + ], + "metadata": { + "resource_version": "192437966" + } + }, + "cnative_proc_specs": [ + { + "name": "web", + "target_replicas": 5, + "target_status": "start", + "max_replicas": 10, + "resource_limit": { + "cpu": "4000m", + "memory": "2048Mi" + }, + "resource_requests": { + "cpu": "200m", + "memory": "1024Mi" + }, + "plan_name": "4C2G", + "resource_limit_quota": { + "cpu": 4000, + "memory": 2048 + }, + "autoscaling": false, + "scaling_config": null, + "cpu_limit": "4000m", + "memory_limit": "2048Mi" + } + ] +} +``` ### Response Result Parameter Description +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| processes | object | Processes information | +| instances | object | Instances information | +| cnative_proc_specs | object | Cloud native process specifications | + +#### .processes filed descriptionn + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| items | array | A list of process items. | +| extra_infos | array | Additional information about the processes. | +| metadata | object | Metadata related to the processes. | + +.process.items + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| module_name | string | The name of the module associated with the process. | +| name | string | The name of the process. | +| type | string | The type of process (e.g., web). | +| command | string | The command executed by the process. | +| replicas | integer | The number of process replicas running. | +| success | integer | The number of successful replicas. | +| failed | integer | The number of failed replicas. | +| version | integer | The version of the process. | +| cluster_link | string | The URL link to the cluster where the process is running. | + +.process.extra_infos + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| type | string | The type of process (e.g., web). | +| command | string | The command executed by the process. | +| cluster_link | string | The URL link to the cluster where the process is running. | + +.process.metadata + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| resource_version | string | The resource version of the processes. | + + +#### .instances filed descriptionn + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| items | array | A list of instance items. | +| metadata | object | Metadata related to the instances. | + +.instances.items + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| module_name | string | The name of the module associated with the instance. | +| name | string | The name of the instance. | +| process_type | string | The type of process for the instance (e.g., web). | +| display_name | string | A display name for the instance. | +| image | string | The Docker image used by the instance. | +| start_time | string | The start time of the instance in ISO 8601 format. | +| state | string | The current state of the instance (e.g., Running). | +| state_message | string | An optional message detailing the state of the instance. | +| rich_status | string | A human-readable representation of the instance's status. | +| ready | boolean | Indicates whether the instance is ready. | +| restart_count | integer | The number of times the instance has been restarted. | +| version | string | The version of the instance. | + +.instances.metadata + +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| resource_version | string | The resource version of the instances. | + + +#### .cnative_proc_specs field description -| Field | Type | Required | Description | -| ----- | ---- | -------- | ----------- | -| instances | ListProcessesOKBodyInstances | Yes | All instance statuses | -| process_packages | []ListProcessesOKBodyProcessPackagesItems0 | Yes | Process configuration status on the platform | -| processes | ListProcessesOKBodyProcesses | Yes | Current process status | - -**ListProcessesOKBodyInstancesItemsItems0** -| Field | Type | Required | Description | -| ----- | ---- | -------- | ----------- | -| display_name | string | Yes | Short name for display | -| name | string | Yes | Instance name | -| process_type | string | Yes | Process type name | -| ready | boolean | Yes | Whether the instance is ready | -| start_time | string | Yes | Instance start time | -| state | string | Yes | Instance status, possible values: "Running" / "Starting" etc. | -| version | integer | Yes | Instance release version number, the client can use this value to compare with Process to determine if the instance is the latest version | - -**ListProcessesOKBodyProcessPackagesItems0** -| Field | Type | Required | Description | -| ----- | ---- | -------- | ----------- | -| max_replicas | integer | Yes | Maximum number of instances allowed by the backend | -| name | string | Yes | Process type, such as "web" | -| resource_limit | string | Yes | CPU and memory limit information | -| target_replicas | integer | Yes | User-set target replica count | -| target_status | integer | Yes | User-set target status | - -**ListProcessesOKBodyProcessesItemsItems0** -| Field | Type | Required | Description | -| ----- | ---- | -------- | ----------- | -| failed | integer | Yes | Error (failed) instance count | -| name | string | Yes | Process name | -| replicas | integer | Yes | Process set (expected) instance count | -| success | integer | Yes | Normal instance count | -| type | string | Yes | Process type | -| version | integer | Yes | Process release version number | - -**ListProcessesOKBodyProcessesMetadata** -| Field | Type | Required | Description | -|------|------|----------|---------| -| resource_version | string| Yes | The local resource version number, which can be used in the rv_proc parameter of a watch request. | \ No newline at end of file +| Field Name | Type | Description | +|-----------------------|----------|-----------------------------------------------------------| +| name | string | The name of the process specification (e.g., web). | +| target_replicas | integer | The target number of replicas for the process. | +| target_status | string | The target status for the process (e.g., start). | +| max_replicas | integer | The maximum number of replicas allowed for the process. | +| resource_limit | object | The resource limits for the process. | +| resource_requests | object | The resource requests for the process. | +| plan_name | string | The name of the resource plan (e.g., 4C2G). | +| resource_limit_quota | object | The quota limits for CPU and memory resources. | +| autoscaling | boolean | Indicates whether autoscaling is enabled for the process. | +| scaling_config | object | The configuration details for autoscaling. | +| cpu_limit | string | The CPU limit for the process (e.g., 4000m). | +| memory_limit | string | The memory limit for the process (e.g., 2048Mi). | \ No newline at end of file diff --git a/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log.md b/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log.md index 05a5109d05..4eb6e4d3a2 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log.md +++ b/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log.md @@ -8,7 +8,7 @@ Query standard output logs | Parameter Name | Parameter Type | Required | Parameter Description | | ------------ | ------------ | ------ | ---------------- | | code | string | Yes | Application ID | -| module | string | Yes | Module name, such as "default" | +| module_name | string | Yes | Module name, such as "default" | #### 2. API Parameters: @@ -25,7 +25,7 @@ Query standard output logs ### Request Example ```bash -curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{code}/modules/{module}/log/structured/list/?time_range=1h' +curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{code}/modules/{module_name}/log/structured/list/?time_range=1h' ``` ### Response Result Example diff --git a/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log_with_post.md b/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log_with_post.md index e416f67a60..50c4974b66 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log_with_post.md +++ b/apiserver/paasng/support-files/apigw/api_doc/en/search_structured_log_with_post.md @@ -7,8 +7,8 @@ Query standard output logs | Parameter Name | Parameter Type | Required | Parameter Description | | ------------ | ------------ | ------ | ---------------- | -| code | string | Yes | Application ID | -| module | string | Yes | Module name, such as "default" | +| code | string | Yes | Application ID | +| module_name | string | Yes | Module name, such as "default" | #### 2. API Parameters: @@ -25,7 +25,7 @@ Query standard output logs ### Request Example ```bash -curl -X -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{code}/modules/{module}/log/structured/list/?time_range=1h' +curl -X -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{code}/modules/{module_name}/log/structured/list/?time_range=1h' ``` ### Response Result Example diff --git a/apiserver/paasng/support-files/apigw/api_doc/en/upload_source_package_via_link.md b/apiserver/paasng/support-files/apigw/api_doc/en/upload_source_package_via_link.md index 40d72495c5..389d955782 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/en/upload_source_package_via_link.md +++ b/apiserver/paasng/support-files/apigw/api_doc/en/upload_source_package_via_link.md @@ -9,7 +9,7 @@ Upload the source code package to the platform according to the download link. | Parameter Name | Parameter Type | Required | Parameter Description | | -------------- | -------------- | -------- | --------------------- | | app_code | string | Yes | Application ID | -| module_name | string | Yes | Module name | +| module | string | Yes | Module name | #### 2. API Parameters: diff --git a/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_framework.md b/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_framework.md index 3b7fee5950..2ea5112468 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_framework.md +++ b/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_framework.md @@ -21,63 +21,158 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"bk_app_code": "***", "bk_app_secret": " ### 返回结果示例 ```json -[{ +[ + { "display_name": "准备阶段", "type": "preparation", - "steps": [{ - "name": "解析应用进程信息", - "display_name": "解析应用进程信息" - }, { - "name": "上传仓库代码", - "display_name": "上传仓库代码" - }, { - "name": "配置资源实例", - "display_name": "配置资源实例" - }] + "steps": [ + { + "name": "解析应用进程信息", + "display_name": "解析应用进程信息", + "skipped": false + }, + { + "name": "上传仓库代码", + "display_name": "上传仓库代码", + "skipped": false + }, + { + "name": "配置资源实例", + "display_name": "配置资源实例", + "skipped": false + } + ], + "display_blocks": { + "source_info": { + "source_type": "", + "type": "", + "trunk_url": null, + "repo_url": null, + "source_dir": "", + "repo_fullname": null, + "diff_feature": {}, + "linked_to_internal_svn": false, + "display_name": "" + }, + "services_info": [ + { + "name": "mysql", + "display_name": "MySQL", + "is_provisioned": true, + "service_id": "c8aa4ce5-f5f2-45ef-b6be-d06a0ce703eb", + "category_id": 1 + } + ], + "prepare_help_docs": [ + { + "title": "应用进程概念介绍以及如何使用", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "关于应用进程的简单介绍，内容包含 Procfile", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "应用进程概念介绍以及如何使用", + "text": "应用进程概念介绍以及如何使用", + "description": "关于应用进程的简单介绍，内容包含 Procfile" + } + ] + } }, { "display_name": "构建阶段", "type": "build", - "steps": [{ - "name": "初始化构建环境", - "display_name": "初始化构建环境" - }, { - "name": "检测构建工具", - "display_name": "检测构建工具" - }, { - "name": "分析构建方案", - "display_name": "分析构建方案" - }, { - "name": "调用 pre-compile", - "display_name": "调用 pre-compile" - }, { - "name": "构建应用", - "display_name": "构建应用" - }, { - "name": "调用 post-compile", - "display_name": "调用 post-compile" - }, { - "name": "生成构建结果", - "display_name": "生成构建结果" - }, { - "name": "清理构建环境", - "display_name": "清理构建环境" - }] + "steps": [ + { + "name": "初始化构建环境", + "display_name": "初始化构建环境", + "skipped": false + }, + { + "name": "分析构建方案", + "display_name": "分析构建方案", + "skipped": false + }, + { + "name": "检测构建工具", + "display_name": "检测构建工具", + "skipped": false + }, + { + "name": "构建应用", + "display_name": "构建应用", + "skipped": false + }, + { + "name": "上传镜像", + "display_name": "上传镜像", + "skipped": false + } + ], + "display_blocks": { + "runtime_info": { + "image": "蓝鲸基础镜像", + "slugbuilder": null, + "slugrunner": null, + "buildpacks": [ + { + "id": 2, + "language": "Python", + "name": "bk-buildpack-python", + "display_name": "Python", + "description": "默认 Python 版本为3.10.5" + } + ] + }, + "build_help_docs": [ + { + "title": "如何使用部署前置命令", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "如何使用部署前置命令", + "text": "如何使用部署前置命令", + "description": "" + } + ] + } }, { "display_name": "部署阶段", "type": "release", - "steps": [{ - "name": "执行部署前置命令", - "display_name": "执行部署前置命令" - }, { - "name": "部署应用", - "display_name": "部署应用" - }, { - "name": "检测部署结果", - "display_name": "检测部署结果" - }] - }] + "steps": [ + { + "name": "部署应用", + "display_name": "部署应用", + "skipped": false + }, + { + "name": "执行部署前置命令", + "display_name": "执行部署前置命令", + "skipped": false + }, + { + "name": "检测部署结果", + "display_name": "检测部署结果", + "skipped": false + } + ], + "display_blocks": { + "access_info": { + "address": "http://apps.example.com/example", + "type": "subpath" + }, + "release_help_docs": [ + { + "title": "配置蓝鲸应用访问入口", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "配置蓝鲸应用访问入口", + "text": "配置蓝鲸应用访问入口", + "description": "" + } + ] + } + } +] ``` ### 返回结果参数说明 @@ -88,9 +183,11 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"bk_app_code": "***", "bk_app_secret": " | display_name | string | 当前阶段的展示用名称(会随着 i18n 改变) | | type | string | 当前阶段类型(可用作标识符) | | steps | List | 当前阶段包含的步骤 | +| display_blocks | object | 当前阶段的展示模块 | #### Step 对象各字段说明 | 参数名称 | 参数类型 | 参数说明 | |-------------|-------------|------------------| | display_name | string | 当前阶段的展示用名称(会随着 i18n 改变) | -| name | string | 当前阶段唯一名称 | \ No newline at end of file +| name | string | 当前阶段唯一名称 | +| skipped | bool | 是否跳过 | \ No newline at end of file diff --git a/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_instance.md b/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_instance.md index b057e455c1..cf4bc5ea8a 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_instance.md +++ b/apiserver/paasng/support-files/apigw/api_doc/zh/get_deploy_phases_instance.md @@ -22,65 +22,217 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"bk_app_code": "***", "bk_app_secret": " ### 返回结果示例 ```json -[{ +[ + { "display_name": "准备阶段", "type": "preparation", - "steps": [{ - "name": "解析应用进程信息", - "display_name": "解析应用进程信息" - }, { - "name": "上传仓库代码", - "display_name": "上传仓库代码" - }, { - "name": "配置资源实例", - "display_name": "配置资源实例" - }] + "steps": [ + { + "name": "解析应用进程信息", + "display_name": "解析应用进程信息", + "skipped": false, + "uuid": "34dace83-6fc0-486b-8a20-1a62b7c2a110", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:33" + }, + { + "name": "上传仓库代码", + "display_name": "上传仓库代码", + "skipped": false, + "uuid": "1a191578-0b9f-4961-8fef-83cfeb3e9421", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "配置资源实例", + "display_name": "配置资源实例", + "skipped": false, + "uuid": "a346504a-b7d6-4c4b-8db2-537e8f43d87d", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:33" + } + ], + "display_blocks": { + "source_info": { + "source_type": "", + "type": "", + "trunk_url": null, + "repo_url": null, + "source_dir": "", + "repo_fullname": null, + "diff_feature": {}, + "linked_to_internal_svn": false, + "display_name": "" + }, + "services_info": [ + { + "name": "mysql", + "display_name": "MySQL", + "is_provisioned": true, + "service_id": "c8aa4ce5-f5f2-45ef-b6be-d06a0ce703eb", + "category_id": 1 + } + ], + "prepare_help_docs": [ + { + "title": "应用进程概念介绍以及如何使用", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "关于应用进程的简单介绍，内容包含 Procfile", + "link": "http://apps.example.com/bk--docs--center/markdown/", + "name": "应用进程概念介绍以及如何使用", + "text": "应用进程概念介绍以及如何使用", + "description": "关于应用进程的简单介绍，内容包含 Procfile" + } + ] + }, + "uuid": "9094bfb2-14ab-41bc-a3bc-1794a2c5115d", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:33" }, { "display_name": "构建阶段", "type": "build", - "steps": [{ - "name": "初始化构建环境", - "display_name": "初始化构建环境" - }, { - "name": "检测构建工具", - "display_name": "检测构建工具" - }, { - "name": "分析构建方案", - "display_name": "分析构建方案" - }, { - "name": "调用 pre-compile", - "display_name": "调用 pre-compile" - }, { - "name": "构建应用", - "display_name": "构建应用" - }, { - "name": "调用 post-compile", - "display_name": "调用 post-compile" - }, { - "name": "生成构建结果", - "display_name": "生成构建结果" - }, { - "name": "清理构建环境", - "display_name": "清理构建环境" - }] + "steps": [ + { + "name": "初始化构建环境", + "display_name": "初始化构建环境", + "skipped": false, + "uuid": "c6220ae7-95e4-4ad8-9ccb-f7cd09689028", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "分析构建方案", + "display_name": "分析构建方案", + "skipped": false, + "uuid": "ae9c4785-5e89-4b65-977d-4180c77ca82b", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "检测构建工具", + "display_name": "检测构建工具", + "skipped": false, + "uuid": "0ef1f2e3-3d90-496e-ab56-a24ece3613a8", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "构建应用", + "display_name": "构建应用", + "skipped": false, + "uuid": "bc9b3bd5-fc2c-4b33-9a14-dba4b14791f9", + "status": null, + "start_time": null, + "complete_time": null + }, + { + "name": "上传镜像", + "display_name": "上传镜像", + "skipped": false, + "uuid": "aefa4786-87af-46c4-8fc5-dc733001dad8", + "status": null, + "start_time": null, + "complete_time": null + } + ], + "display_blocks": { + "runtime_info": { + "image": "蓝鲸基础镜像", + "slugbuilder": null, + "slugrunner": null, + "buildpacks": [ + { + "id": 2, + "language": "Python", + "name": "bk-buildpack-python", + "display_name": "Python", + "description": "默认 Python 版本为3.10.5" + } + ] + }, + "build_help_docs": [ + { + "title": "如何使用部署前置命令", + "location": "http://apps.example.com/bk--docs--center/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/", + "name": "如何使用部署前置命令", + "text": "如何使用部署前置命令", + "description": "" + } + ] + }, + "uuid": "51d9e97f-da21-42dc-a24d-0d20286d9ee5", + "status": null, + "start_time": null, + "complete_time": null }, { "display_name": "部署阶段", "type": "release", - "steps": [{ - "name": "执行部署前置命令", - "display_name": "执行部署前置命令" - }, { - "name": "部署应用", - "display_name": "部署应用" - }, { - "name": "检测部署结果", - "display_name": "检测部署结果" - }] - }] + "steps": [ + { + "name": "部署应用", + "display_name": "部署应用", + "skipped": false, + "uuid": "223b64c0-0c6b-478e-a839-3339d75b2838", + "status": "successful", + "start_time": "2024-08-16 10:07:33", + "complete_time": "2024-08-16 10:07:34" + }, + { + "name": "执行部署前置命令", + "display_name": "执行部署前置命令", + "skipped": false, + "uuid": "3a9e3144-f300-46f2-90c3-1b2f4097bff1", + "status": "successful", + "start_time": "2024-08-16 10:07:34", + "complete_time": "2024-08-16 10:07:55" + }, + { + "name": "检测部署结果", + "display_name": "检测部署结果", + "skipped": false, + "uuid": "3f7e961d-fbb7-4c43-952a-3826513ca426", + "status": "successful", + "start_time": "2024-08-16 10:07:34", + "complete_time": "2024-08-16 10:08:07" + } + ], + "display_blocks": { + "access_info": { + "address": "http://apps.example.com/bk--notice/", + "type": "subpath" + }, + "release_help_docs": [ + { + "title": "配置蓝鲸应用访问入口", + "location": "http://apps.example.com/bk--docs--center/markdown/", + "short_description": "", + "link": "http://apps.example.com/bk--docs--center/markdown/PaaS/", + "name": "配置蓝鲸应用访问入口", + "text": "配置蓝鲸应用访问入口", + "description": "" + } + ] + }, + "uuid": "4dbe12b7-7a19-4a31-9a21-a080c6e71a08", + "status": "successful", + "start_time": "2024-08-16 10:08:07", + "complete_time": "2024-08-16 10:08:07" + } +] ``` + ### 返回结果参数说明 #### Phase 对象各字段说明 @@ -89,9 +241,19 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"bk_app_code": "***", "bk_app_secret": " | display_name | string | 当前阶段的展示用名称(会随着 i18n 改变) | | type | string | 当前阶段类型(可用作标识符) | | steps | List | 当前阶段包含的步骤 | +| display_blocks | object | 当前阶段的展示模块 | +| uuid | string | UUID | +| status | string | 状态 | +| start_time| string | 开始时间 | +| complete_time | string | 结束时间 | #### Step 对象各字段说明 | 参数名称 | 参数类型 | 参数说明 | |-------------|--------------|-----------------| | display_name | string | 当前阶段的展示用名称(会随着 i18n 改变) | -| name | string | 当前阶段唯一名称 | \ No newline at end of file +| name | string | 当前阶段唯一名称 | +| skipped | bool | 是否跳过 | +| uuid | string | uuid | +| status | string | 状态 | +| start_time| string | 开始时间 | +| complete_time | string | 结束时间 | \ No newline at end of file diff --git a/apiserver/paasng/support-files/apigw/api_doc/zh/list_processes.md b/apiserver/paasng/support-files/apigw/api_doc/zh/list_processes.md index 28019c0ffb..c241ecf9ca 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/zh/list_processes.md +++ b/apiserver/paasng/support-files/apigw/api_doc/zh/list_processes.md @@ -23,46 +23,172 @@ curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app ### 返回结果示例 Status: OK +```json +{ + "processes": { + "items": [ + { + "module_name": "default", + "name": "example--web", + "type": "web", + "command": "", + "replicas": 5, + "success": 5, + "failed": 0, + "version": 175, + "cluster_link": "http://example--web.bkapp-example-prod" + } + ], + "extra_infos": [ + { + "type": "web", + "command": "", + "cluster_link": "http://example--web.bkapp-example-prod" + } + ], + "metadata": { + "resource_version": "192437966" + } + }, + "instances": { + "items": [ + { + "module_name": "default", + "name": "example--web-699599bf76-78jzf", + "process_type": "web", + "display_name": "78jzf", + "image": "docker.example.com/bkpaas/docker/example/default:1.5.5", + "start_time": "2024-08-16T02:07:55Z", + "state": "Running", + "state_message": null, + "rich_status": "Running", + "ready": true, + "restart_count": 0, + "version": "175" + } + ], + "metadata": { + "resource_version": "192437966" + } + }, + "cnative_proc_specs": [ + { + "name": "web", + "target_replicas": 5, + "target_status": "start", + "max_replicas": 10, + "resource_limit": { + "cpu": "4000m", + "memory": "2048Mi" + }, + "resource_requests": { + "cpu": "200m", + "memory": "1024Mi" + }, + "plan_name": "4C2G", + "resource_limit_quota": { + "cpu": 4000, + "memory": 2048 + }, + "autoscaling": false, + "scaling_config": null, + "cpu_limit": "4000m", + "memory_limit": "2048Mi" + } + ] +} +``` ### 返回结果参数说明 -| 字段 | 类型 | 是否必填 | 描述 | -| ------ | ------ | ------ | ------ | -| instances | ListProcessesOKBodyInstances | 是 | 所有实例状态 | -| process_packages | []ListProcessesOKBodyProcessPackagesItems0 | 是 | 进程在平台的配置状态 | -| processes | ListProcessesOKBodyProcesses | 是 | 进程当前状态 | +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| processes | object | 进程信息 | +| instances | object | 实例信息 | +| cnative_proc_specs | object | 云原生进程配置信息 | -**ListProcessesOKBodyInstancesItemsItems0** -| 字段 | 类型 | 是否必填 | 描述 | -| ------ | ------ | ------ | ------ | -| display_name | string | 是 | 用于展示的短名字 | -| name | string | 是 | 实例名称 | -| process_type | string | 是 | 进程类型名称 | -| ready | boolean | 是 | 实例是否就绪 | -| start_time | string | 是 | 实例启动时间 | -| state | string | 是 | 实例状态，可能的值："Running" / "Starting" 等 | -| version | integer | 是 | 实例 release 版本号，客户端可使用该值与 Process 进行对比，判断实例是否为最新版 | - -**ListProcessesOKBodyProcessPackagesItems0** -| 字段 | 类型 | 是否必填 | 描述 | -| ------ | ------ | ------ | ------ | -| max_replicas | integer | 是 | 后台允许的最大实例数 | -| name | string | 是 | 进程类型，如 "web" | -| resource_limit | string | 是 | CPU 与内存限制信息 | -| target_replicas | integer | 是 | 用户设置的目标副本数 | -| target_status | integer | 是 | 用户设置的目标状态 | - -**ListProcessesOKBodyProcessesItemsItems0** -| 字段 | 类型 | 是否必填 | 描述 | -| ------ | ------ | ------ | ------ | -| failed | integer | 是 | 错误（失败）实例数 | -| name | string | 是 | 进程名称 | -| replicas | integer | 是 | 进程设置（预期）实例数 | -| success | integer | 是 | 正常实例数 | -| type | string | 是 | 进程类型 | -| version | integer | 是 | 进程 release 版本号 | - -**ListProcessesOKBodyProcessesMetadata** -| 字段 | 类型 | 必选 | 描述 | -|------|------|---------|---------| -| resource_version | string| 是 | 本地资源版本号，可用于 watch 请求的 rv_proc 参数 | \ No newline at end of file + +#### .processes 字段说明 + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| items | array | 包含进程项的列表 | +| extra_infos | array | 关于进程的附加信息 | +| metadata | object | 与进程相关的元数据 | + +.process.items + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| module_name | string | 与进程关联的模块名称 | +| name | string | 进程的名称 | +| type | string | 进程的类型（例如，web） | +| command | string | 进程执行的命令 | +| replicas | integer | 正在运行的进程副本数量 | +| success | integer | 成功的副本数量 | +| failed | integer | 失败的副本数量 | +| version | integer | 进程的版本 | +| cluster_link | string | 进程运行所在集群的URL链接 | + +.process.extra_infos + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| type | string | 进程的类型（例如，web） | +| command | string | 进程执行的命令 | +| cluster_link | string | 进程运行所在集群的URL链接 | + +.process.metadata + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| resource_version | string | 进程的资源版本 | + + +#### .instances + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| items | array | 包含实例项的列表 | +| metadata | object | 与实例相关的元数据 | + +.instances.items + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| module_name | string | 与实例关联的模块名称 | +| name | string | 实例的名称 | +| process_type | string | 实例的进程类型（例如，web） | +| display_name | string | 实例的显示名称，通常从实例的唯一标识符派生 | +| image | string | 实例使用的Docker镜像 | +| start_time | string | 实例的开始时间，采用ISO 8601格式 | +| state | string | 实例的当前状态（例如，Running） | +| state_message | string | 描述实例状态的可选信息 | +| rich_status | string | 实例状态的易读表示 | +| ready | boolean | 表示实例是否已准备好 | +| restart_count | integer | 实例重新启动的次数 | +| version | string | 实例的版本 | + +.instances.metadata + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| resource_version | string | 实例的资源版本 | + + +#### .cnative_proc_specs 字段说明 + +| 名称 | 类型 | 说明 | +|-----------------------|----------|-----------------------------------------------------------| +| name | string | 进程规格的名称（例如，web） | +| target_replicas | integer | 进程的目标副本数 | +| target_status | string | 进程的目标状态（例如，start） | +| max_replicas | integer | 进程允许的最大副本数 | +| resource_limit | object | 进程的资源限制 | +| resource_requests | object | 进程的资源请求 | +| plan_name | string | 资源计划的名称（例如，4C2G） | +| resource_limit_quota | object | CPU和内存资源的配额限制 | +| autoscaling | boolean | 表示进程是否启用了自动扩展 | +| scaling_config | object | 自动扩展的配置详情 | +| cpu_limit | string | 进程的CPU限制（例如，4000m） | +| memory_limit | string | 进程的内存限制（例如，2048Mi） | \ No newline at end of file diff --git a/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log.md b/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log.md index 0311fd53f3..f4507ca4bb 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log.md +++ b/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log.md @@ -8,7 +8,7 @@ | 参数名称 | 参数类型 | 必须 | 参数说明 | | ------------ | ------------ | ------ | ---------------- | | app_code | string | 是 | 应用 ID | -| module | string | 是 | 模块名称，如 "default" | +| module_name | string | 是 | 模块名称，如 "default" | #### 2、接口参数： @@ -25,7 +25,7 @@ ### 请求示例 ```bash -curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{app_code}/modules/{module}/log/structured/list/?time_range=1h' +curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{app_code}/modules/{module_name}/log/structured/list/?time_range=1h' ``` ### 返回结果示例 diff --git a/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log_with_post.md b/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log_with_post.md index 8c585aadda..487055e2d4 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log_with_post.md +++ b/apiserver/paasng/support-files/apigw/api_doc/zh/search_structured_log_with_post.md @@ -8,7 +8,7 @@ | 参数名称 | 参数类型 | 必须 | 参数说明 | | ------------ | ------------ | ------ | ---------------- | | app_code | string | 是 | 应用 ID | -| module | string | 是 | 模块名称，如 "default" | +| module_name | string | 是 | 模块名称，如 "default" | #### 2、接口参数： @@ -25,7 +25,7 @@ ### 请求示例 ```bash -curl -X POST -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{app_code}/modules/{module}/log/structured/list/?time_range=1h' +curl -X POST -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app_secret": "***"}' --insecure 'https://bkapi.example.com/api/bkpaas3/prod/system/applications/{app_code}/modules/{module_name}/log/structured/list/?time_range=1h' ``` ### 返回结果示例 diff --git a/apiserver/paasng/support-files/apigw/api_doc/zh/upload_source_package_via_link.md b/apiserver/paasng/support-files/apigw/api_doc/zh/upload_source_package_via_link.md index 27dbe4a660..41d921d014 100644 --- a/apiserver/paasng/support-files/apigw/api_doc/zh/upload_source_package_via_link.md +++ b/apiserver/paasng/support-files/apigw/api_doc/zh/upload_source_package_via_link.md @@ -7,8 +7,8 @@ | 参数名称 | 参数类型 | 必须 | 参数说明 | | -------- | -------- | --- | -------- | -| app_code | string | 是 | 应用 ID | -| module_name | string | 是 | 模块名称 | +| app_code | string | 是 | 应用 ID | +| modules | string | 是 | 模块名称 | #### 2、接口参数：