@alicloud/pai-dlc20201203 1.10.0 → 1.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -79,13 +79,13 @@ export default class Client extends OpenApi {
79
79
  */
80
80
  createRayHistoryServer(request: $_model.CreateRayHistoryServerRequest): Promise<$_model.CreateRayHistoryServerResponse>;
81
81
  /**
82
- * 创建信号
82
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
83
83
  *
84
84
  * @remarks
85
- * ## 请求说明
86
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
87
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
88
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
85
+ * ## Operation description
86
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
87
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
88
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
89
89
  *
90
90
  * @param request - CreateSignalRequest
91
91
  * @param headers - map
@@ -96,13 +96,13 @@ export default class Client extends OpenApi {
96
96
  [key: string]: string;
97
97
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSignalResponse>;
98
98
  /**
99
- * 创建信号
99
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
100
100
  *
101
101
  * @remarks
102
- * ## 请求说明
103
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
104
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
105
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
102
+ * ## Operation description
103
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
104
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
105
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
106
106
  *
107
107
  * @param request - CreateSignalRequest
108
108
  * @returns CreateSignalResponse
@@ -436,11 +436,11 @@ export default class Client extends OpenApi {
436
436
  */
437
437
  getRayHistoryServer(RayHistoryServerId: string, request: $_model.GetRayHistoryServerRequest): Promise<$_model.GetRayHistoryServerResponse>;
438
438
  /**
439
- * 获取信号
439
+ * Queries the details of a specific signal in a specified job.
440
440
  *
441
441
  * @remarks
442
- * ## 请求说明
443
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
442
+ * ## Operation description
443
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
444
444
  *
445
445
  * @param request - GetSignalRequest
446
446
  * @param headers - map
@@ -451,11 +451,11 @@ export default class Client extends OpenApi {
451
451
  [key: string]: string;
452
452
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetSignalResponse>;
453
453
  /**
454
- * 获取信号
454
+ * Queries the details of a specific signal in a specified job.
455
455
  *
456
456
  * @remarks
457
- * ## 请求说明
458
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
457
+ * ## Operation description
458
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
459
459
  *
460
460
  * @param request - GetSignalRequest
461
461
  * @returns GetSignalResponse
@@ -632,11 +632,11 @@ export default class Client extends OpenApi {
632
632
  */
633
633
  listRayHistoryServers(request: $_model.ListRayHistoryServersRequest): Promise<$_model.ListRayHistoryServersResponse>;
634
634
  /**
635
- * 获取信号列表
635
+ * Queries all signal records of a specified job.
636
636
  *
637
637
  * @remarks
638
- * ## 请求说明
639
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
638
+ * ## Operation description
639
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
640
640
  *
641
641
  * @param request - ListSignalsRequest
642
642
  * @param headers - map
@@ -647,11 +647,11 @@ export default class Client extends OpenApi {
647
647
  [key: string]: string;
648
648
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSignalsResponse>;
649
649
  /**
650
- * 获取信号列表
650
+ * Queries all signal records of a specified job.
651
651
  *
652
652
  * @remarks
653
- * ## 请求说明
654
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
653
+ * ## Operation description
654
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
655
655
  *
656
656
  * @param request - ListSignalsRequest
657
657
  * @returns ListSignalsResponse
package/dist/client.js CHANGED
@@ -375,13 +375,13 @@ class Client extends openapi_core_1.default {
375
375
  return await this.createRayHistoryServerWithOptions(request, headers, runtime);
376
376
  }
377
377
  /**
378
- * 创建信号
378
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
379
379
  *
380
380
  * @remarks
381
- * ## 请求说明
382
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
383
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
384
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
381
+ * ## Operation description
382
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
383
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
384
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
385
385
  *
386
386
  * @param request - CreateSignalRequest
387
387
  * @param headers - map
@@ -415,13 +415,13 @@ class Client extends openapi_core_1.default {
415
415
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateSignalResponse({}));
416
416
  }
417
417
  /**
418
- * 创建信号
418
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
419
419
  *
420
420
  * @remarks
421
- * ## 请求说明
422
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
423
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
424
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
421
+ * ## Operation description
422
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
423
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
424
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
425
425
  *
426
426
  * @param request - CreateSignalRequest
427
427
  * @returns CreateSignalResponse
@@ -1257,11 +1257,11 @@ class Client extends openapi_core_1.default {
1257
1257
  return await this.getRayHistoryServerWithOptions(RayHistoryServerId, request, headers, runtime);
1258
1258
  }
1259
1259
  /**
1260
- * 获取信号
1260
+ * Queries the details of a specific signal in a specified job.
1261
1261
  *
1262
1262
  * @remarks
1263
- * ## 请求说明
1264
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
1263
+ * ## Operation description
1264
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
1265
1265
  *
1266
1266
  * @param request - GetSignalRequest
1267
1267
  * @param headers - map
@@ -1292,11 +1292,11 @@ class Client extends openapi_core_1.default {
1292
1292
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetSignalResponse({}));
1293
1293
  }
1294
1294
  /**
1295
- * 获取信号
1295
+ * Queries the details of a specific signal in a specified job.
1296
1296
  *
1297
1297
  * @remarks
1298
- * ## 请求说明
1299
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
1298
+ * ## Operation description
1299
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
1300
1300
  *
1301
1301
  * @param request - GetSignalRequest
1302
1302
  * @returns GetSignalResponse
@@ -1905,11 +1905,11 @@ class Client extends openapi_core_1.default {
1905
1905
  return await this.listRayHistoryServersWithOptions(request, headers, runtime);
1906
1906
  }
1907
1907
  /**
1908
- * 获取信号列表
1908
+ * Queries all signal records of a specified job.
1909
1909
  *
1910
1910
  * @remarks
1911
- * ## 请求说明
1912
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
1911
+ * ## Operation description
1912
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
1913
1913
  *
1914
1914
  * @param request - ListSignalsRequest
1915
1915
  * @param headers - map
@@ -1955,11 +1955,11 @@ class Client extends openapi_core_1.default {
1955
1955
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListSignalsResponse({}));
1956
1956
  }
1957
1957
  /**
1958
- * 获取信号列表
1958
+ * Queries all signal records of a specified job.
1959
1959
  *
1960
1960
  * @remarks
1961
- * ## 请求说明
1962
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
1961
+ * ## Operation description
1962
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
1963
1963
  *
1964
1964
  * @param request - ListSignalsRequest
1965
1965
  * @returns ListSignalsResponse
@@ -2,10 +2,17 @@ import * as $dara from '@darabonba/typescript';
2
2
  import { SignalTarget } from "./SignalTarget";
3
3
  export declare class CreateSignalRequest extends $dara.Model {
4
4
  /**
5
+ * @remarks
6
+ * The signal code.
7
+ *
5
8
  * @example
6
9
  * SIGUSR1
7
10
  */
8
11
  signal?: string;
12
+ /**
13
+ * @remarks
14
+ * The signal delivery scope.
15
+ */
9
16
  target?: SignalTarget;
10
17
  static names(): {
11
18
  [key: string]: string;
@@ -1 +1 @@
1
- {"version":3,"file":"CreateSignalRequest.js","sourceRoot":"","sources":["../../src/models/CreateSignalRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAC/C,iDAA8C;AAG9C,MAAa,mBAAoB,SAAQ,KAAK,CAAC,KAAK;IAOlD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,2BAAY;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,MAAM,IAAI,OAAQ,IAAI,CAAC,MAAc,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACrE,IAAI,CAAC,MAAc,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA/BD,kDA+BC"}
1
+ {"version":3,"file":"CreateSignalRequest.js","sourceRoot":"","sources":["../../src/models/CreateSignalRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAC/C,iDAA8C;AAG9C,MAAa,mBAAoB,SAAQ,KAAK,CAAC,KAAK;IAclD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,2BAAY;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,MAAM,IAAI,OAAQ,IAAI,CAAC,MAAc,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACrE,IAAI,CAAC,MAAc,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAtCD,kDAsCC"}
@@ -1,26 +1,41 @@
1
1
  import * as $dara from '@darabonba/typescript';
2
2
  export declare class CreateSignalResponseBody extends $dara.Model {
3
3
  /**
4
+ * @remarks
5
+ * The job ID.
6
+ *
4
7
  * @example
5
8
  * dlc********
6
9
  */
7
10
  jobId?: string;
8
11
  /**
12
+ * @remarks
13
+ * The request ID.
14
+ *
9
15
  * @example
10
16
  * 019F6385-7481-57A7-BEC9-***********
11
17
  */
12
18
  requestId?: string;
13
19
  /**
20
+ * @remarks
21
+ * The signal code.
22
+ *
14
23
  * @example
15
24
  * SIGUSR1
16
25
  */
17
26
  signal?: string;
18
27
  /**
28
+ * @remarks
29
+ * The signal ID.
30
+ *
19
31
  * @example
20
32
  * oper************
21
33
  */
22
34
  signalId?: string;
23
35
  /**
36
+ * @remarks
37
+ * The signal status.
38
+ *
24
39
  * @example
25
40
  * Succeeded
26
41
  */
@@ -1 +1 @@
1
- {"version":3,"file":"CreateSignalResponseBody.js","sourceRoot":"","sources":["../../src/models/CreateSignalResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,wBAAyB,SAAQ,KAAK,CAAC,KAAK;IA0BvD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AArDD,4DAqDC"}
1
+ {"version":3,"file":"CreateSignalResponseBody.js","sourceRoot":"","sources":["../../src/models/CreateSignalResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,wBAAyB,SAAQ,KAAK,CAAC,KAAK;IAyCvD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AApED,4DAoEC"}
@@ -1,6 +1,9 @@
1
1
  import * as $dara from '@darabonba/typescript';
2
2
  export declare class GetSignalRequest extends $dara.Model {
3
3
  /**
4
+ * @remarks
5
+ * The temporary token used for authentication.
6
+ *
4
7
  * @example
5
8
  * eyXXXX-XXXX.XXXXX
6
9
  */
@@ -1 +1 @@
1
- {"version":3,"file":"GetSignalRequest.js","sourceRoot":"","sources":["../../src/models/GetSignalRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,gBAAiB,SAAQ,KAAK,CAAC,KAAK;IAM/C,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAzBD,4CAyBC"}
1
+ {"version":3,"file":"GetSignalRequest.js","sourceRoot":"","sources":["../../src/models/GetSignalRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,gBAAiB,SAAQ,KAAK,CAAC,KAAK;IAS/C,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5BD,4CA4BC"}
@@ -1,53 +1,91 @@
1
1
  import * as $dara from '@darabonba/typescript';
2
2
  export declare class GetSignalResponseBody extends $dara.Model {
3
3
  /**
4
+ * @remarks
5
+ * The creation time.
6
+ *
4
7
  * @example
5
8
  * 2026-03-18T10:02:04+08:00
6
9
  */
7
10
  gmtCreated?: string;
8
11
  /**
12
+ * @remarks
13
+ * The modification time.
14
+ *
9
15
  * @example
10
16
  * 2026-03-18T10:02:04+08:00
11
17
  */
12
18
  gmtModified?: string;
13
19
  /**
20
+ * @remarks
21
+ * The job ID.
22
+ *
14
23
  * @example
15
24
  * oper***********
16
25
  */
17
26
  jobId?: string;
18
27
  /**
28
+ * @remarks
29
+ * The status description, which contains a summary for each pod (number of successful deliveries, names of failed or pending pods, etc.).
30
+ *
19
31
  * @example
20
32
  * signal delivered to 1 pods
21
33
  */
22
34
  message?: string;
35
+ /**
36
+ * @remarks
37
+ * The list of pod names.
38
+ */
23
39
  podNames?: string[];
24
40
  /**
41
+ * @remarks
42
+ * The status reason code, such as `Completed`, `SignalFailed`, or `StoppedByJobEnded`.
43
+ *
25
44
  * @example
26
45
  * Completed
27
46
  */
28
47
  reason?: string;
29
48
  /**
49
+ * @remarks
50
+ * The request ID.
51
+ *
30
52
  * @example
31
53
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxx
32
54
  */
33
55
  requestId?: string;
56
+ /**
57
+ * @remarks
58
+ * The list of role objects.
59
+ */
34
60
  roles?: string[];
35
61
  /**
62
+ * @remarks
63
+ * The delivery scope.
64
+ *
36
65
  * @example
37
66
  * pods
38
67
  */
39
68
  scope?: string;
40
69
  /**
70
+ * @remarks
71
+ * The signal.
72
+ *
41
73
  * @example
42
74
  * SIGUSR1
43
75
  */
44
76
  signal?: string;
45
77
  /**
78
+ * @remarks
79
+ * The signal ID.
80
+ *
46
81
  * @example
47
82
  * dlc***********
48
83
  */
49
84
  signalId?: string;
50
85
  /**
86
+ * @remarks
87
+ * The signal status.
88
+ *
51
89
  * @example
52
90
  * Succeeded
53
91
  */
@@ -1 +1 @@
1
- {"version":3,"file":"GetSignalResponseBody.js","sourceRoot":"","sources":["../../src/models/GetSignalResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IAqDpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,aAAa;YAC1B,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,QAAQ;YACrB,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACnD,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YAChD,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AApGD,sDAoGC"}
1
+ {"version":3,"file":"GetSignalResponseBody.js","sourceRoot":"","sources":["../../src/models/GetSignalResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IA2FpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,aAAa;YAC1B,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,QAAQ;YACrB,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACnD,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YAChD,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA1ID,sDA0IC"}
@@ -1,31 +1,49 @@
1
1
  import * as $dara from '@darabonba/typescript';
2
2
  export declare class ListSignalsRequest extends $dara.Model {
3
3
  /**
4
+ * @remarks
5
+ * The sort order.
6
+ *
4
7
  * @example
5
8
  * desc
6
9
  */
7
10
  order?: string;
8
11
  /**
12
+ * @remarks
13
+ * The current page number.
14
+ *
9
15
  * @example
10
16
  * 1
11
17
  */
12
18
  pageNumber?: string;
13
19
  /**
20
+ * @remarks
21
+ * The number of entries per page.
22
+ *
14
23
  * @example
15
24
  * 20
16
25
  */
17
26
  pageSize?: string;
18
27
  /**
28
+ * @remarks
29
+ * The field used for sorting.
30
+ *
19
31
  * @example
20
32
  * GmtCreateTime
21
33
  */
22
34
  sortBy?: string;
23
35
  /**
36
+ * @remarks
37
+ * The signal status.
38
+ *
24
39
  * @example
25
40
  * Succeeded
26
41
  */
27
42
  status?: string;
28
43
  /**
44
+ * @remarks
45
+ * The temporary token used for authentication.
46
+ *
29
47
  * @example
30
48
  * eyXXXX-XXXX.XXXXX
31
49
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ListSignalsRequest.js","sourceRoot":"","sources":["../../src/models/ListSignalsRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,kBAAmB,SAAQ,KAAK,CAAC,KAAK;IA+BjD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;YACd,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5DD,gDA4DC"}
1
+ {"version":3,"file":"ListSignalsRequest.js","sourceRoot":"","sources":["../../src/models/ListSignalsRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,kBAAmB,SAAQ,KAAK,CAAC,KAAK;IAiDjD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;YACd,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA9ED,gDA8EC"}
@@ -1,43 +1,75 @@
1
1
  import * as $dara from '@darabonba/typescript';
2
2
  export declare class ListSignalsResponseBodySignals extends $dara.Model {
3
3
  /**
4
+ * @remarks
5
+ * The creation time.
6
+ *
4
7
  * @example
5
8
  * 2025-12-30T14:07:38+08:00
6
9
  */
7
10
  gmtCreated?: string;
8
11
  /**
12
+ * @remarks
13
+ * The modification time.
14
+ *
9
15
  * @example
10
16
  * 2025-12-30T14:07:38+08:00
11
17
  */
12
18
  gmtModified?: string;
13
19
  /**
20
+ * @remarks
21
+ * The message returned with the result.
22
+ *
14
23
  * @example
15
24
  * signal delivered to 1 pods
16
25
  */
17
26
  message?: string;
27
+ /**
28
+ * @remarks
29
+ * The list of pod names.
30
+ */
18
31
  podNames?: string[];
19
32
  /**
33
+ * @remarks
34
+ * The reason.
35
+ *
20
36
  * @example
21
37
  * Completed
22
38
  */
23
39
  reason?: string;
40
+ /**
41
+ * @remarks
42
+ * The list of role types.
43
+ */
24
44
  roles?: string[];
25
45
  /**
46
+ * @remarks
47
+ * The delivery scope.
48
+ *
26
49
  * @example
27
50
  * pods
28
51
  */
29
52
  scope?: string;
30
53
  /**
54
+ * @remarks
55
+ * The signal code.
56
+ *
31
57
  * @example
32
58
  * SIGUSR1
33
59
  */
34
60
  signal?: string;
35
61
  /**
62
+ * @remarks
63
+ * The signal ID.
64
+ *
36
65
  * @example
37
66
  * oper*********
38
67
  */
39
68
  signalId?: string;
40
69
  /**
70
+ * @remarks
71
+ * The signal status.
72
+ *
41
73
  * @example
42
74
  * Stopped
43
75
  */
@@ -55,27 +87,46 @@ export declare class ListSignalsResponseBodySignals extends $dara.Model {
55
87
  }
56
88
  export declare class ListSignalsResponseBody extends $dara.Model {
57
89
  /**
90
+ * @remarks
91
+ * The job ID.
92
+ *
58
93
  * @example
59
94
  * dlc-...
60
95
  */
61
96
  jobId?: string;
62
97
  /**
98
+ * @remarks
99
+ * The current page number.
100
+ *
63
101
  * @example
64
102
  * 1
65
103
  */
66
104
  pageNumber?: number;
67
105
  /**
106
+ * @remarks
107
+ * The number of entries per page.
108
+ *
68
109
  * @example
69
110
  * 20
70
111
  */
71
112
  pageSize?: number;
72
113
  /**
114
+ * @remarks
115
+ * The request ID.
116
+ *
73
117
  * @example
74
118
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxx
75
119
  */
76
120
  requestId?: string;
121
+ /**
122
+ * @remarks
123
+ * The list of signal records for the job. Each element has the same structure as the response of GetSignal.
124
+ */
77
125
  signals?: ListSignalsResponseBodySignals[];
78
126
  /**
127
+ * @remarks
128
+ * The total number of records.
129
+ *
79
130
  * @example
80
131
  * 3
81
132
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ListSignalsResponseBody.js","sourceRoot":"","sources":["../../src/models/ListSignalsResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,8BAA+B,SAAQ,KAAK,CAAC,KAAK;IA2C7D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACnD,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YAChD,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAtFD,wEAsFC;AAED,MAAa,uBAAwB,SAAQ,KAAK,CAAC,KAAK;IA2BtD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;YACd,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,8BAA8B,EAAE;YACxE,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA3DD,0DA2DC"}
1
+ {"version":3,"file":"ListSignalsResponseBody.js","sourceRoot":"","sources":["../../src/models/ListSignalsResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,8BAA+B,SAAQ,KAAK,CAAC,KAAK;IA2E7D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACnD,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YAChD,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAtHD,wEAsHC;AAED,MAAa,uBAAwB,SAAQ,KAAK,CAAC,KAAK;IA8CtD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,OAAO;YACd,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,8BAA8B,EAAE;YACxE,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA9ED,0DA8EC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alicloud/pai-dlc20201203",
3
- "version": "1.10.0",
3
+ "version": "1.10.1",
4
4
  "description": "",
5
5
  "main": "dist/client.js",
6
6
  "scripts": {
package/src/client.ts CHANGED
@@ -388,13 +388,13 @@ export default class Client extends OpenApi {
388
388
  }
389
389
 
390
390
  /**
391
- * 创建信号
391
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
392
392
  *
393
393
  * @remarks
394
- * ## 请求说明
395
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
396
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
397
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
394
+ * ## Operation description
395
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
396
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
397
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
398
398
  *
399
399
  * @param request - CreateSignalRequest
400
400
  * @param headers - map
@@ -431,13 +431,13 @@ export default class Client extends OpenApi {
431
431
  }
432
432
 
433
433
  /**
434
- * 创建信号
434
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
435
435
  *
436
436
  * @remarks
437
- * ## 请求说明
438
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
439
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
440
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
437
+ * ## Operation description
438
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
439
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
440
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
441
441
  *
442
442
  * @param request - CreateSignalRequest
443
443
  * @returns CreateSignalResponse
@@ -1363,11 +1363,11 @@ export default class Client extends OpenApi {
1363
1363
  }
1364
1364
 
1365
1365
  /**
1366
- * 获取信号
1366
+ * Queries the details of a specific signal in a specified job.
1367
1367
  *
1368
1368
  * @remarks
1369
- * ## 请求说明
1370
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
1369
+ * ## Operation description
1370
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
1371
1371
  *
1372
1372
  * @param request - GetSignalRequest
1373
1373
  * @param headers - map
@@ -1400,11 +1400,11 @@ export default class Client extends OpenApi {
1400
1400
  }
1401
1401
 
1402
1402
  /**
1403
- * 获取信号
1403
+ * Queries the details of a specific signal in a specified job.
1404
1404
  *
1405
1405
  * @remarks
1406
- * ## 请求说明
1407
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
1406
+ * ## Operation description
1407
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
1408
1408
  *
1409
1409
  * @param request - GetSignalRequest
1410
1410
  * @returns GetSignalResponse
@@ -2111,11 +2111,11 @@ export default class Client extends OpenApi {
2111
2111
  }
2112
2112
 
2113
2113
  /**
2114
- * 获取信号列表
2114
+ * Queries all signal records of a specified job.
2115
2115
  *
2116
2116
  * @remarks
2117
- * ## 请求说明
2118
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
2117
+ * ## Operation description
2118
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
2119
2119
  *
2120
2120
  * @param request - ListSignalsRequest
2121
2121
  * @param headers - map
@@ -2168,11 +2168,11 @@ export default class Client extends OpenApi {
2168
2168
  }
2169
2169
 
2170
2170
  /**
2171
- * 获取信号列表
2171
+ * Queries all signal records of a specified job.
2172
2172
  *
2173
2173
  * @remarks
2174
- * ## 请求说明
2175
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
2174
+ * ## Operation description
2175
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
2176
2176
  *
2177
2177
  * @param request - ListSignalsRequest
2178
2178
  * @returns ListSignalsResponse
@@ -5,10 +5,17 @@ import { SignalTarget } from "./SignalTarget";
5
5
 
6
6
  export class CreateSignalRequest extends $dara.Model {
7
7
  /**
8
+ * @remarks
9
+ * The signal code.
10
+ *
8
11
  * @example
9
12
  * SIGUSR1
10
13
  */
11
14
  signal?: string;
15
+ /**
16
+ * @remarks
17
+ * The signal delivery scope.
18
+ */
12
19
  target?: SignalTarget;
13
20
  static names(): { [key: string]: string } {
14
21
  return {
@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class CreateSignalResponseBody extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The job ID.
9
+ *
7
10
  * @example
8
11
  * dlc********
9
12
  */
10
13
  jobId?: string;
11
14
  /**
15
+ * @remarks
16
+ * The request ID.
17
+ *
12
18
  * @example
13
19
  * 019F6385-7481-57A7-BEC9-***********
14
20
  */
15
21
  requestId?: string;
16
22
  /**
23
+ * @remarks
24
+ * The signal code.
25
+ *
17
26
  * @example
18
27
  * SIGUSR1
19
28
  */
20
29
  signal?: string;
21
30
  /**
31
+ * @remarks
32
+ * The signal ID.
33
+ *
22
34
  * @example
23
35
  * oper************
24
36
  */
25
37
  signalId?: string;
26
38
  /**
39
+ * @remarks
40
+ * The signal status.
41
+ *
27
42
  * @example
28
43
  * Succeeded
29
44
  */
@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class GetSignalRequest extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The temporary token used for authentication.
9
+ *
7
10
  * @example
8
11
  * eyXXXX-XXXX.XXXXX
9
12
  */
@@ -4,53 +4,91 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class GetSignalResponseBody extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The creation time.
9
+ *
7
10
  * @example
8
11
  * 2026-03-18T10:02:04+08:00
9
12
  */
10
13
  gmtCreated?: string;
11
14
  /**
15
+ * @remarks
16
+ * The modification time.
17
+ *
12
18
  * @example
13
19
  * 2026-03-18T10:02:04+08:00
14
20
  */
15
21
  gmtModified?: string;
16
22
  /**
23
+ * @remarks
24
+ * The job ID.
25
+ *
17
26
  * @example
18
27
  * oper***********
19
28
  */
20
29
  jobId?: string;
21
30
  /**
31
+ * @remarks
32
+ * The status description, which contains a summary for each pod (number of successful deliveries, names of failed or pending pods, etc.).
33
+ *
22
34
  * @example
23
35
  * signal delivered to 1 pods
24
36
  */
25
37
  message?: string;
38
+ /**
39
+ * @remarks
40
+ * The list of pod names.
41
+ */
26
42
  podNames?: string[];
27
43
  /**
44
+ * @remarks
45
+ * The status reason code, such as `Completed`, `SignalFailed`, or `StoppedByJobEnded`.
46
+ *
28
47
  * @example
29
48
  * Completed
30
49
  */
31
50
  reason?: string;
32
51
  /**
52
+ * @remarks
53
+ * The request ID.
54
+ *
33
55
  * @example
34
56
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxx
35
57
  */
36
58
  requestId?: string;
59
+ /**
60
+ * @remarks
61
+ * The list of role objects.
62
+ */
37
63
  roles?: string[];
38
64
  /**
65
+ * @remarks
66
+ * The delivery scope.
67
+ *
39
68
  * @example
40
69
  * pods
41
70
  */
42
71
  scope?: string;
43
72
  /**
73
+ * @remarks
74
+ * The signal.
75
+ *
44
76
  * @example
45
77
  * SIGUSR1
46
78
  */
47
79
  signal?: string;
48
80
  /**
81
+ * @remarks
82
+ * The signal ID.
83
+ *
49
84
  * @example
50
85
  * dlc***********
51
86
  */
52
87
  signalId?: string;
53
88
  /**
89
+ * @remarks
90
+ * The signal status.
91
+ *
54
92
  * @example
55
93
  * Succeeded
56
94
  */
@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class ListSignalsRequest extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The sort order.
9
+ *
7
10
  * @example
8
11
  * desc
9
12
  */
10
13
  order?: string;
11
14
  /**
15
+ * @remarks
16
+ * The current page number.
17
+ *
12
18
  * @example
13
19
  * 1
14
20
  */
15
21
  pageNumber?: string;
16
22
  /**
23
+ * @remarks
24
+ * The number of entries per page.
25
+ *
17
26
  * @example
18
27
  * 20
19
28
  */
20
29
  pageSize?: string;
21
30
  /**
31
+ * @remarks
32
+ * The field used for sorting.
33
+ *
22
34
  * @example
23
35
  * GmtCreateTime
24
36
  */
25
37
  sortBy?: string;
26
38
  /**
39
+ * @remarks
40
+ * The signal status.
41
+ *
27
42
  * @example
28
43
  * Succeeded
29
44
  */
30
45
  status?: string;
31
46
  /**
47
+ * @remarks
48
+ * The temporary token used for authentication.
49
+ *
32
50
  * @example
33
51
  * eyXXXX-XXXX.XXXXX
34
52
  */
@@ -4,43 +4,75 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class ListSignalsResponseBodySignals extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The creation time.
9
+ *
7
10
  * @example
8
11
  * 2025-12-30T14:07:38+08:00
9
12
  */
10
13
  gmtCreated?: string;
11
14
  /**
15
+ * @remarks
16
+ * The modification time.
17
+ *
12
18
  * @example
13
19
  * 2025-12-30T14:07:38+08:00
14
20
  */
15
21
  gmtModified?: string;
16
22
  /**
23
+ * @remarks
24
+ * The message returned with the result.
25
+ *
17
26
  * @example
18
27
  * signal delivered to 1 pods
19
28
  */
20
29
  message?: string;
30
+ /**
31
+ * @remarks
32
+ * The list of pod names.
33
+ */
21
34
  podNames?: string[];
22
35
  /**
36
+ * @remarks
37
+ * The reason.
38
+ *
23
39
  * @example
24
40
  * Completed
25
41
  */
26
42
  reason?: string;
43
+ /**
44
+ * @remarks
45
+ * The list of role types.
46
+ */
27
47
  roles?: string[];
28
48
  /**
49
+ * @remarks
50
+ * The delivery scope.
51
+ *
29
52
  * @example
30
53
  * pods
31
54
  */
32
55
  scope?: string;
33
56
  /**
57
+ * @remarks
58
+ * The signal code.
59
+ *
34
60
  * @example
35
61
  * SIGUSR1
36
62
  */
37
63
  signal?: string;
38
64
  /**
65
+ * @remarks
66
+ * The signal ID.
67
+ *
39
68
  * @example
40
69
  * oper*********
41
70
  */
42
71
  signalId?: string;
43
72
  /**
73
+ * @remarks
74
+ * The signal status.
75
+ *
44
76
  * @example
45
77
  * Stopped
46
78
  */
@@ -92,27 +124,46 @@ export class ListSignalsResponseBodySignals extends $dara.Model {
92
124
 
93
125
  export class ListSignalsResponseBody extends $dara.Model {
94
126
  /**
127
+ * @remarks
128
+ * The job ID.
129
+ *
95
130
  * @example
96
131
  * dlc-...
97
132
  */
98
133
  jobId?: string;
99
134
  /**
135
+ * @remarks
136
+ * The current page number.
137
+ *
100
138
  * @example
101
139
  * 1
102
140
  */
103
141
  pageNumber?: number;
104
142
  /**
143
+ * @remarks
144
+ * The number of entries per page.
145
+ *
105
146
  * @example
106
147
  * 20
107
148
  */
108
149
  pageSize?: number;
109
150
  /**
151
+ * @remarks
152
+ * The request ID.
153
+ *
110
154
  * @example
111
155
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxx
112
156
  */
113
157
  requestId?: string;
158
+ /**
159
+ * @remarks
160
+ * The list of signal records for the job. Each element has the same structure as the response of GetSignal.
161
+ */
114
162
  signals?: ListSignalsResponseBodySignals[];
115
163
  /**
164
+ * @remarks
165
+ * The total number of records.
166
+ *
116
167
  * @example
117
168
  * 3
118
169
  */