diff --git a/paas2/VERSION b/paas2/VERSION index 404df319b..562510f86 100644 --- a/paas2/VERSION +++ b/paas2/VERSION @@ -1 +1 @@ -2.12.22 +2.12.23 diff --git a/paas2/esb/components/confapis/bk_log/bk_log.yaml b/paas2/esb/components/confapis/bk_log/bk_log.yaml index 924b22e05..dbc07f766 100644 --- a/paas2/esb/components/confapis/bk_log/bk_log.yaml +++ b/paas2/esb/components/confapis/bk_log/bk_log.yaml @@ -11,6 +11,17 @@ dest_http_method: POST is_hidden: True +- path: /v2/bk_log/esquery_monitor/ + name: esquery_monitor + label: 日志平台索引集查询接口 + label_en: bk_log index-set search api for bkmonitor + method: POST + api_type: query + comp_codename: generic.v2.bk_log.bk_log_component + dest_path: /api/v1/esquery/search/ + dest_http_method: POST + is_hidden: True + - path: /v2/bk_log/esquery_dsl/ name: esquery_dsl label: ES-DSL查询接口 diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/create_credential.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/create_credential.md new file mode 100644 index 000000000..f47ef85ab --- /dev/null +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/create_credential.md @@ -0,0 +1,58 @@ +### 功能描述 + +新建凭据。 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|------------|--------|------------| +| bk_biz_id | long | 是 | 业务 ID | +| name | string | 是 | 凭据名称 | +| type | string | 是 | 凭据类型，取值可为ACCESS_KEY_SECRET_KEY,PASSWORD,USERNAME_PASSWORD,SECRET_KEY | +| description | string | 否 | 凭据描述 | +| access_key | string | 否 | 凭据类型为ACCESS_KEY_SECRET_KEY时填写 | +| secret_key | string | 否 | 凭据类型为ACCESS_KEY_SECRET_KEY/SECRET_KEY时填写 | +| username | string | 否 | 凭据类型为USERNAME_PASSWORD时填写 | +| password | string | 否 | 凭据类型为USERNAME_PASSWORD/PASSWORD时填写 | + + +### 请求参数示例 + +```json +{ + "bk_app_code": "esb_test", + "bk_app_secret": "xxx", + "bk_token": "xxx", + "bk_biz_id": 1, + "name": "testCredential", + "type": "USERNAME_PASSWORD", + "description": "This is a test credential", + "username": "admin", + "password": "password" +} +``` + +### 返回结果示例 + +```json +{ + "result": true, + "code": 0, + "message": "success", + "data": { + "id": "06644309e10e4068b3c7b32799668210" + } +} +``` + +### 返回结果参数说明 + +#### data + +| 字段 | 类型 |字段是否一定存在 | 描述 | +|-----------|-------|---------------|---------| +| id | string |是 | 凭据ID | diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/create_file_source.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/create_file_source.md new file mode 100644 index 000000000..0fbf6dc56 --- /dev/null +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/create_file_source.md @@ -0,0 +1,75 @@ +### 功能描述 + +新建文件源，当前仅支持创建关联自动选择公共接入点的蓝鲸制品库文件源。 +创建的文件源具备以下默认特性： + +| 特性 | 取值 | +|-----------------|------------| +|存储类型|对象存储| +|文件源类型|蓝鲸制品库| +|是否为公共文件源|否| +|接入点选择范围|公共接入点| +|接入点选择模式|自动| + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|------------|--------|------------| +| bk_biz_id | long | 是 | 业务 ID | +| code | string | 是 | 文件源标识，英文字符开头，1-32位英文字符、下划线、数字组成，创建后不可更改 | +| alias | string | 是 | 文件源别名 | +| type | string | 是 | 文件源类型，当前仅支持蓝鲸制品库，BLUEKING_ARTIFACTORY | +| access_params | object | 是 | 文件源接入参数，根据type传入不同的对象，见后续说明 | +| credential_id | string | 否 | 文件源使用的凭据Id | +| file_prefix | string | 否 | Job对从该文件源分发的文件加上的前缀，不传默认不加前缀 | + +### access_params +**type为BLUEKING_ARTIFACTORY** + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|------------|--------|------------| +| base_url | string | 是 | 对接的制品库实例根地址，例如：https://bkrepo.com | + +### 请求参数示例 + +```json +{ + "bk_app_code": "esb_test", + "bk_app_secret": "xxx", + "bk_token": "xxx", + "bk_biz_id": 1, + "code": "sopsArtifactory", + "alias": "标准运维制品库文件源", + "type": "BLUEKING_ARTIFACTORY", + "access_params": { + "base_url": "https://bkrepo.com" + }, + "credential_id": "06644309e10e4068b3c7b32799668210", + "file_prefix": "" +} +``` + +### 返回结果示例 + +```json +{ + "result": true, + "code": 0, + "message": "success", + "data": { + "id": 1 + } +} +``` + +### 返回结果参数说明 + +#### data + +| 字段 | 类型 |字段是否一定存在 | 描述 | +|-----------|-------|---------------|---------| +| id | int |是 | 文件源ID | diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_script.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_script.md index e5dc89b26..b25731208 100644 --- a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_script.md +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_script.md @@ -101,7 +101,8 @@ "message": "success", "data": { "job_instance_name": "API Quick execution script1521100521303", - "job_instance_id": 10000 + "job_instance_id": 10000, + "step_instance_id": 10001 } } ``` diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_sql.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_sql.md index 47ee07c9e..1266b04cd 100644 --- a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_sql.md +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_execute_sql.md @@ -93,7 +93,8 @@ "message": "success", "data": { "job_instance_name": "API Quick SQL Execution1524454292038", - "job_instance_id": 10000 + "job_instance_id": 10000, + "step_instance_id": 10001 } } ``` diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_transfer_file.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_transfer_file.md index b8b5281a4..4d18f5cb9 100644 --- a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_transfer_file.md +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/fast_transfer_file.md @@ -148,7 +148,8 @@ "message": "success", "data": { "job_instance_name": "API Quick Distribution File1521101427176", - "job_instance_id": 10000 + "job_instance_id": 10000, + "step_instance_id": 10001 } } ``` diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/get_job_instance_ip_log.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/get_job_instance_ip_log.md index bba715d65..7e3423efb 100644 --- a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/get_job_instance_ip_log.md +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/get_job_instance_ip_log.md @@ -13,8 +13,8 @@ | bk_biz_id | long | 是 | 业务ID | | job_instance_id | long | 是 | 作业实例ID | | step_instance_id | long | 是 | 步骤实例ID | -| bk_cloud_id | int | 是 | 云区域ID | -| ip | string | 是 | IP | +| bk_cloud_id | int | 是 | 目标服务器云区域ID | +| ip | string | 是 | 目标服务器IP | ### 请求参数示例 @@ -33,24 +33,95 @@ ### 返回结果示例 +#### 脚本执行步骤 ```json { "result": true, "code": 0, "message": "", "data": { + "log_type": 1, "ip": "10.0.0.1", "bk_cloud_id": 0, "log_content": "[2018-03-15 14:39:30][PID:56875] job_start\n" } } ``` + +#### 文件分发步骤 + +```json +{ + "result": true, + "code": 0, + "message": "", + "data": { + "log_type": 2, + "ip": "10.0.0.1", + "bk_cloud_id": 0, + "file_logs": [ + { + "mode": 1, + "src_ip": { + "bk_cloud_id": 0, + "ip": "10.0.0.2" + }, + "src_path": "/data/1.log", + "dest_ip": { + "bk_cloud_id": 0, + "ip": "10.0.0.1" + }, + "dest_path": "/tmp/1.log", + "status": 4, + "log_content": "[2021-06-28 11:32:16] FileName: /tmp/1.log FileSize: 9.0 Bytes State: dest agent success download file Speed: 1 KB/s Progress: 100% StatusDesc: dest agent success download file Detail: success" + }, + { + "mode": 0, + "src_ip": { + "bk_cloud_id": 0, + "ip": "10.0.0.2" + }, + "src_path": "/data/1.log", + "status": 4, + "log_content": "[2021-06-28 11:32:16] FileName: /data/1.log FileSize: 9.0 Bytes State: source agent success upload file Speed: 1 KB/s Progress: 100% StatusDesc: source agent success upload file Detail: success upload" + } + ] + } +} +``` + +**返回结果说明** + +- 文件分发日志，除了目标服务器的文件下载任务日志，也会返回源服务器的文件上传任务日志(mode=0) +- dest_ip 与请求参数的bk_cloud_id/ip对应 + ### 返回结果参数说明 #### data | 字段 | 类型 | 描述 | |-----------|-----------|-----------| -| bk_cloud_id | int | 云区域ID | -| ip | string | IP地址 | +| bk_cloud_id | int | 目标服务器云区域ID | +| ip | string | 目标服务器IP地址 | +| log_type | int | 日志类型。1-脚本执行任务日志;2-文件分发任务日志 | | log_content | string | 作业脚本输出的日志内容 | +| file_logs | array | 文件分发任务日志。定义见file_log| + +#### file_log + +| 字段 | 类型 | 描述 | +|-----------|-----------|-----------| +| mode | 分发模式 | 0:上传;1:下载| +| src_ip | object |文件源主机IP。定义见ip | +| src_path | string | 源文件路径 | +| dest_ip | object | 分发目标主机IP，mode=1时有值。定义见ip | +| dest_path | string | 目标路径，mode=1时有值 | +| status | int | 任务状态。1-等待开始;2-上传中;3-下载中;4-成功;5-失败 | +| log_content | string | 文件分发日志内容 | + +#### ip + +| 字段 | 类型 | 描述 | +|-----------|------------|--------| +| bk_cloud_id | long | 云区域ID | +| ip | string | IP地址 | diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/update_credential.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/update_credential.md new file mode 100644 index 000000000..589aa11d5 --- /dev/null +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/update_credential.md @@ -0,0 +1,60 @@ +### 功能描述 + +更新凭据。 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|------------|--------|------------| +| bk_biz_id | long | 是 | 业务 ID | +| id | string | 是 | 凭据 ID | +| name | string | 否 | 凭据名称 | +| type | string | 否 | 凭据类型，取值可为ACCESS_KEY_SECRET_KEY,PASSWORD,USERNAME_PASSWORD,SECRET_KEY | +| description | string | 否 | 凭据描述 | +| access_key | string | 否 | 凭据类型为ACCESS_KEY_SECRET_KEY时填写 | +| secret_key | string | 否 | 凭据类型为ACCESS_KEY_SECRET_KEY/SECRET_KEY时填写 | +| username | string | 否 | 凭据类型为USERNAME_PASSWORD时填写 | +| password | string | 否 | 凭据类型为USERNAME_PASSWORD/PASSWORD时填写 | + + +### 请求参数示例 + +```json +{ + "bk_app_code": "esb_test", + "bk_app_secret": "xxx", + "bk_token": "xxx", + "bk_biz_id": 1, + "id": "06644309e10e4068b3c7b32799668210", + "name": "testCredential", + "type": "USERNAME_PASSWORD", + "description": "This is a new credential", + "username": "admin", + "password": "newPassword" +} +``` + +### 返回结果示例 + +```json +{ + "result": true, + "code": 0, + "message": "success", + "data": { + "id": "06644309e10e4068b3c7b32799668210" + } +} +``` + +### 返回结果参数说明 + +#### data + +| 字段 | 类型 |字段是否一定存在 | 描述 | +|-----------|-------|---------------|---------| +| id | string |是 | 凭据ID | diff --git a/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/update_file_source.md b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/update_file_source.md new file mode 100644 index 000000000..f3a0d341d --- /dev/null +++ b/paas2/esb/components/confapis/jobv3/apidocs/zh_hans/update_file_source.md @@ -0,0 +1,67 @@ +### 功能描述 + +更新文件源。 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|------------|--------|------------| +| bk_biz_id | long | 是 | 业务 ID | +| id | int | 否 | 文件源ID，与code二者至少填一个，同时填写以id为准 | +| code | string | 否 | 文件源标识，与id二者至少填一个，同时填写以id为准，英文字符开头，1-32位英文字符、下划线、数字组成，创建后不可更改 | +| alias | string | 否 | 文件源别名 | +| type | string | 否 | 文件源类型，当前仅支持蓝鲸制品库，BLUEKING_ARTIFACTORY | +| access_params | object | 否 | 文件源接入参数，根据type传入不同的对象，见后续说明 | +| credential_id | string | 否 | 文件源使用的凭据Id | +| file_prefix | string | 否 | Job对从该文件源分发的文件加上的前缀，不传默认不加前缀 | + +### access_params +**type为BLUEKING_ARTIFACTORY** + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|------------|--------|------------| +| base_url | string | 是 | 对接的制品库实例根地址，例如：https://bkrepo.com | + +### 请求参数示例 + +```json +{ + "bk_app_code": "esb_test", + "bk_app_secret": "xxx", + "bk_token": "xxx", + "bk_biz_id": 1, + "code": "sopsArtifactory", + "alias": "标准运维制品库文件源", + "type": "BLUEKING_ARTIFACTORY", + "access_params": { + "base_url": "https://bkrepo.com" + }, + "credential_id": "06644309e10e4068b3c7b32799668210", + "file_prefix": "" +} +``` + +### 返回结果示例 + +```json +{ + "result": true, + "code": 0, + "message": "success", + "data": { + "id": 1 + } +} +``` + +### 返回结果参数说明 + +#### data + +| 字段 | 类型 |字段是否一定存在 | 描述 | +|------------|--------|---------------|-----------| +| id | int |是 | 文件源ID | diff --git a/paas2/esb/components/confapis/jobv3/job.yaml b/paas2/esb/components/confapis/jobv3/job.yaml index a709f66ca..b7e37b8a4 100644 --- a/paas2/esb/components/confapis/jobv3/job.yaml +++ b/paas2/esb/components/confapis/jobv3/job.yaml @@ -309,4 +309,46 @@ dest_http_method: POST is_hidden: True +- path: /v2/jobv3/create_credential/ + name: create_credential + label: 新建凭据 + label_en: Create credential + suggest_method: POST + api_type: operate + comp_codename: generic.v2.jobv3.job_component + dest_path: /api/job/v3/job-manage/create_credential/ + dest_http_method: POST + is_hidden: True + +- path: /v2/jobv3/update_credential/ + name: update_credential + label: 更新凭据 + label_en: Update credential + suggest_method: POST + api_type: operate + comp_codename: generic.v2.jobv3.job_component + dest_path: /api/job/v3/job-manage/update_credential/ + dest_http_method: POST + is_hidden: True +- path: /v2/jobv3/create_file_source/ + name: create_file_source + label: 新建文件源 + label_en: Create file source + suggest_method: POST + api_type: operate + comp_codename: generic.v2.jobv3.job_component + dest_path: /api/job/v3/job-file-gateway/create_file_source/ + dest_http_method: POST + is_hidden: True + +- path: /v2/jobv3/update_file_source/ + name: update_file_source + label: 更新文件源 + label_en: Update file source + suggest_method: POST + api_type: operate + comp_codename: generic.v2.jobv3.job_component + dest_path: /api/job/v3/job-file-gateway/update_file_source/ + dest_http_method: POST + is_hidden: True diff --git a/paas2/release.md b/paas2/release.md index 135fbf8ef..cbe554d59 100644 --- a/paas2/release.md +++ b/paas2/release.md @@ -1,5 +1,8 @@ Release Log =============================== +# 2.12.23 + - update: esb update jobv3/bk_log confapis + # 2.12.22 - bugfix: fix esb fs_list_users xss - update: esb add staff_status field for fs_list_users