perf: 提供根据特征数据查询任务信息的APIGW工具接口 #3398 #3424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liuliaozhong
approved these changes
Feb 14, 2025
| * 业务ID | ||
| */ | ||
| @JsonProperty("bk_app_id") | ||
| private Long appId; |
There was a problem hiding this comment.
appId是个兼容字段，接口返回统一命名成：bk_biz_id
| import java.util.List; | ||
|
|
||
| @Data | ||
| public class EsbTaskLinkV3DTO { |
There was a problem hiding this comment.
响应体包含scopeType、scopeId、appId属性，建议继承EsbAppScopeDTO.java
| EsbTaskLinkV3DTO esbTaskLinkV3DTO = new EsbTaskLinkV3DTO(); | ||
| esbTaskLinkV3DTO.setJobInstanceId(stepInstanceBase.getTaskInstanceId()); | ||
| esbTaskLinkV3DTO.setStepInstanceId(stepInstanceBase.getId()); | ||
| esbTaskLinkV3DTO.setAppId(stepInstanceBase.getAppId()); |
There was a problem hiding this comment.
appId是兼容字段，一般不返回（具体看是否开启了兼容特性）。资源信息赋值建议使用EsbDTOAppScopeMappingHelper.java工具类
| | data | List<TaskLinkDTO> | Data returned by request | | ||
| | permission | object | Permission information | | ||
| | request_id | string | Request chain id | | ||
|
|
There was a problem hiding this comment.
response部分，可以用公共片段引入，{% include '_generic_response.md.j2' %}
There was a problem hiding this comment.
模版中的reponse data字段类型为object，我想强调一下data的类型是List的
| | data | List<TaskLinkDTO> | 请求返回的数据 | | ||
| | request_id | string | 请求ID | | ||
| | permission | object | 权限信息 | | ||
|
|
There was a problem hiding this comment.
response部分，可以用公共片段引入，{% include '_generic_response.md.j2' %}
| get: | ||
| operationId : system_query_gse_task | ||
| description : 根据step_id查询gse task id | ||
| tags : [ 'system' ] |
There was a problem hiding this comment.
在YAML语法中，表示列表方括号与内容之间不需要空格
| get : | ||
| operationId : system_query_job_instance | ||
| description : 根据gse_task_id查询job任务 | ||
| tags : [ 'system' ] |
There was a problem hiding this comment.
在YAML语法中，表示列表方括号与内容之间不需要空格
| authConfig : | ||
| appVerifiedRequired : true | ||
| userVerifiedRequired : false | ||
| resourcePermissionRequired : true |
There was a problem hiding this comment.
多处YAML规范需要调整下，key和冒号之间不需要空格，但冒号最后面需要跟一个空格以分隔键和值
| @@ -75,7 +75,7 @@ query gse task id by step instance id | |||
| |------------------|----------|---------------------------------------------------------------------------------------------| | |||
| | bk_scope_type | string | Resource scope type. Optional values: biz - Business，biz_set - Business Set | | |||
| | bk_scope_id | string | Resource scope ID. Corresponds to bk_scope_type, which means business ID or business set ID | | |||
| | bk_app_id | long | Business ID | | |||
| | bk_biz_id | long | Business ID | | |||
There was a problem hiding this comment.
bk_biz_id从3.5.x以后就不推荐使用了，但是为了兼容老版本接口仍然保留着这字段，建议文档上不写了
| @@ -51,7 +51,7 @@ query job link by gse task id | |||
| |------------------|----------|---------------------------------------------------------------------------------------------| | |||
| | bk_scope_type | string | Resource scope type. Optional values: biz - Business，biz_set - Business Set | | |||
| | bk_scope_id | string | Resource scope ID. Corresponds to bk_scope_type, which means business ID or business set ID | | |||
| | bk_app_id | long | Business ID | | |||
| | bk_biz_id | long | Business ID | | |||
There was a problem hiding this comment.
bk_biz_id从3.5.x以后就不推荐使用了，但是为了兼容老版本接口仍然保留着这字段，建议文档上不写了
| @@ -75,7 +75,7 @@ | |||
| |------------------|----------|-----------------------------------------| | |||
| | bk_scope_type | string | 资源范围类型。可选值: biz - 业务，biz_set - 业务集 | | |||
| | bk_scope_id | string | 资源范围ID, 与bk_scope_type对应, 表示业务ID或者业务集ID | | |||
| | bk_app_id | long | 业务ID | | |||
| | bk_biz_id | long | 业务ID | | |||
| @@ -51,7 +51,7 @@ | |||
| |------------------|----------|-----------------------------------------| | |||
| | bk_scope_type | string | 资源范围类型。可选值: biz - 业务，biz_set - 业务集 | | |||
| | bk_scope_id | string | 资源范围ID, 与bk_scope_type对应, 表示业务ID或者业务集ID | | |||
| | bk_app_id | long | 业务ID | | |||
| | bk_biz_id | long | 业务ID | | |||
jsonwan
reviewed
Feb 17, 2025
support-files/bk-api-gateway/v3/apidocs/en/system_query_gse_task.md.j2
Outdated
Show resolved
Hide resolved
jsonwan
reviewed
Feb 17, 2025
support-files/bk-api-gateway/v3/apidocs/en/system_query_gse_task.md.j2
Outdated
Show resolved
Hide resolved
jsonwan
reviewed
Feb 17, 2025
support-files/bk-api-gateway/v3/apidocs/en/system_query_job_instance.md.j2
Outdated
Show resolved
Hide resolved
jsonwan
reviewed
Feb 17, 2025
support-files/bk-api-gateway/v3/apidocs/zh/system_query_gse_task.md.j2
Outdated
Show resolved
Hide resolved
jsonwan
reviewed
Feb 17, 2025
support-files/bk-api-gateway/v3/apidocs/zh/system_query_gse_task.md.j2
Outdated
Show resolved
Hide resolved
jsonwan
reviewed
Feb 17, 2025
support-files/bk-api-gateway/v3/apidocs/zh/system_query_job_instance.md.j2
Outdated
Show resolved
Hide resolved
jsonwan
reviewed
Feb 17, 2025
jsonwan
reviewed
Feb 17, 2025
jsonwan
approved these changes
Feb 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.