perf: 提供步骤详情与步骤执行结果查询的APIGW接口 TencentBlueKing#2596

步骤详情接口添加bk_cloud_name字段
jsonwan · Jan 10, 2024 · 9a02fec · 9a02fec
1 parent 40e220f
commit 9a02fec
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/docs/apidoc/bk-api-gateway/v3/zh/get_step_instance_detail.md b/docs/apidoc/bk-api-gateway/v3/zh/get_step_instance_detail.md
@@ -59,6 +59,7 @@
             "ip_list": [{
               "bk_host_id": 1,
               "bk_cloud_id": 0,
+              "bk_cloud_name": "Default Area",
               "ip": "192.168.1.1",
               "ipv6": null,
               "bk_agent_id": "020000000052540079809816967513755991",
@@ -89,6 +90,7 @@
                   "ip_list": [{
                     "bk_host_id": 1,
                     "bk_cloud_id": 0,
+                    "bk_cloud_name": "Default Area",
                     "ip": "192.168.1.1",
                     "ipv6": null,
                     "bk_agent_id": "020000000052540079809816967513755991",
@@ -121,6 +123,7 @@
               "ip_list": [{
                 "bk_host_id": 1,
                 "bk_cloud_id": 0,
+                "bk_cloud_name": "Default Area",
                 "ip": "192.168.1.1",
                 "ipv6": null,
                 "bk_agent_id": "020000000052540079809816967513755991",
@@ -203,14 +206,15 @@
 
 ##### host
 
-| 字段         | 类型       | 是否一定存在 | 描述      |
-|-------------|-----------|------------|-----------|
-| bk_host_id  | long      |  是        | 主机ID     |
-| bk_cloud_id | long      |  否        | 管控区域ID  |
-| ip          | string    |  否        | IP        |
-| ipv6        | string    |  否        | IPv6      |
-| bk_agent_id | string    |  否        | Agent ID  |
-| alive       | int       |  否        | Agent是否正常，取值为：1-正常，0-异常 |
+| 字段           | 类型       | 是否一定存在 | 描述      |
+|---------------|-----------|------------|-----------|
+| bk_host_id    | long      |  是        | 主机ID     |
+| bk_cloud_id   | long      |  否        | 管控区域ID  |
+| bk_cloud_name | string    |  否        | 管控区域名称 |
+| ip            | string    |  否        | IP        |
+| ipv6          | string    |  否        | IPv6      |
+| bk_agent_id   | string    |  否        | Agent ID  |
+| alive         | int       |  否        | Agent是否正常，取值为：1-正常，0-异常 |
 
 ##### topo_node
 

diff --git a/...ckend/commons/esb-sdk/src/main/java/com/tencent/bk/job/common/esb/model/job/EsbIpDTO.java b/...ckend/commons/esb-sdk/src/main/java/com/tencent/bk/job/common/esb/model/job/EsbIpDTO.java
@@ -52,6 +52,10 @@ public class EsbIpDTO {
     @JsonPropertyDescription("BK-Network Area")
     private Long bkCloudId;
 
+    @JsonProperty("bk_cloud_name")
+    @JsonPropertyDescription("BK-Network Area Name")
+    private String bkCloudName;
+
     @JsonProperty("ip")
     @Pattern(regexp = "\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)" +
         "\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)" +
@@ -95,6 +99,7 @@ public static EsbIpDTO fromHost(HostDTO host) {
         }
         EsbIpDTO esbIp = new EsbIpDTO();
         esbIp.setBkCloudId(host.getBkCloudId());
+        esbIp.setBkCloudName(host.getBkCloudName());
         esbIp.setIp(host.getIp());
         esbIp.setIpv6(host.getIpv6());
         esbIp.setHostId(host.getHostId());