@alicloud/apig20240327 11.3.4 → 11.4.0

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.
Files changed (46) hide show
  1. package/dist/client.d.ts +34 -8
  2. package/dist/client.js +56 -8
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateMigrationTaskRequest.d.ts +2 -0
  5. package/dist/models/CreateMigrationTaskRequest.js.map +1 -1
  6. package/dist/models/GetDashboardRequest.d.ts +10 -6
  7. package/dist/models/GetDashboardRequest.js.map +1 -1
  8. package/dist/models/GetDashboardResponseBody.d.ts +2 -2
  9. package/dist/models/GetDashboardShrinkRequest.d.ts +10 -6
  10. package/dist/models/GetDashboardShrinkRequest.js.map +1 -1
  11. package/dist/models/GetGatewayQuotaRuleSubjectUsageRequest.d.ts +3 -3
  12. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.d.ts +9 -9
  13. package/dist/models/GetGatewayResourceQuotaUsageRequest.d.ts +13 -0
  14. package/dist/models/GetGatewayResourceQuotaUsageRequest.js +54 -0
  15. package/dist/models/GetGatewayResourceQuotaUsageRequest.js.map +1 -0
  16. package/dist/models/GetGatewayResourceQuotaUsageResponse.d.ts +19 -0
  17. package/dist/models/GetGatewayResourceQuotaUsageResponse.js +69 -0
  18. package/dist/models/GetGatewayResourceQuotaUsageResponse.js.map +1 -0
  19. package/dist/models/GetGatewayResourceQuotaUsageResponseBody.d.ts +141 -0
  20. package/dist/models/GetGatewayResourceQuotaUsageResponseBody.js +122 -0
  21. package/dist/models/GetGatewayResourceQuotaUsageResponseBody.js.map +1 -0
  22. package/dist/models/UpdateConsumerAuthorizationRuleResponseBody.d.ts +1 -1
  23. package/dist/models/UpdateGatewayQuotaRuleRequest.d.ts +7 -7
  24. package/dist/models/UpdateGatewayQuotaRuleResponseBody.d.ts +13 -13
  25. package/dist/models/UpdateHttpApiRequest.d.ts +10 -2
  26. package/dist/models/UpdateHttpApiRequest.js +2 -0
  27. package/dist/models/UpdateHttpApiRequest.js.map +1 -1
  28. package/dist/models/model.d.ts +5 -0
  29. package/dist/models/model.js +28 -18
  30. package/dist/models/model.js.map +1 -1
  31. package/package.json +1 -1
  32. package/src/client.ts +59 -8
  33. package/src/models/CreateMigrationTaskRequest.ts +2 -0
  34. package/src/models/GetDashboardRequest.ts +10 -6
  35. package/src/models/GetDashboardResponseBody.ts +2 -2
  36. package/src/models/GetDashboardShrinkRequest.ts +10 -6
  37. package/src/models/GetGatewayQuotaRuleSubjectUsageRequest.ts +3 -3
  38. package/src/models/GetGatewayQuotaRuleSubjectUsageResponseBody.ts +9 -9
  39. package/src/models/GetGatewayResourceQuotaUsageRequest.ts +24 -0
  40. package/src/models/GetGatewayResourceQuotaUsageResponse.ts +40 -0
  41. package/src/models/GetGatewayResourceQuotaUsageResponseBody.ts +200 -0
  42. package/src/models/UpdateConsumerAuthorizationRuleResponseBody.ts +1 -1
  43. package/src/models/UpdateGatewayQuotaRuleRequest.ts +7 -7
  44. package/src/models/UpdateGatewayQuotaRuleResponseBody.ts +13 -13
  45. package/src/models/UpdateHttpApiRequest.ts +12 -2
  46. package/src/models/model.ts +5 -0
@@ -35,7 +35,7 @@ export class GetDashboardRequestFilter extends $dara.Model {
35
35
  export class GetDashboardRequest extends $dara.Model {
36
36
  /**
37
37
  * @remarks
38
- * The language. Valid values:
38
+ * The language of the response. Valid values:
39
39
  *
40
40
  * - zh: Chinese
41
41
  * - en: English
@@ -59,10 +59,12 @@ export class GetDashboardRequest extends $dara.Model {
59
59
  filter?: GetDashboardRequestFilter;
60
60
  /**
61
61
  * @remarks
62
- * The dashboard name. Valid values:
62
+ * The name of the dashboard. Valid values:
63
63
  *
64
- * - LOG: access log
65
- * - PLUGIN: plugin log
64
+ * - LOG: Access log.
65
+ * - PLUGIN: Plugin log.
66
+ *
67
+ * > Note: This parameter is required. If this parameter is not specified, the API returns InvalidParameter.IsEmpty (400).
66
68
  *
67
69
  * @example
68
70
  * PLUGIN
@@ -94,9 +96,11 @@ export class GetDashboardRequest extends $dara.Model {
94
96
  routeId?: string;
95
97
  /**
96
98
  * @remarks
97
- * The dashboard source. Valid values:
99
+ * The source of the dashboard. Valid values:
100
+ *
101
+ * - SLS: Log dashboard.
98
102
  *
99
- * - SLS: log dashboard
103
+ * > Note: This parameter is required. If this parameter is not specified, the API returns InvalidParameter.IsEmpty (400).
100
104
  *
101
105
  * @example
102
106
  * SLS
@@ -13,7 +13,7 @@ export class GetDashboardResponseBodyData extends $dara.Model {
13
13
  gatewayId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The dashboard name.
16
+ * The name of the dashboard.
17
17
  *
18
18
  * @example
19
19
  * PLUGIN
@@ -21,7 +21,7 @@ export class GetDashboardResponseBodyData extends $dara.Model {
21
21
  name?: string;
22
22
  /**
23
23
  * @remarks
24
- * The dashboard title.
24
+ * The title of the dashboard.
25
25
  *
26
26
  * @example
27
27
  * APIG Plugin
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetDashboardShrinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The language. Valid values:
8
+ * The language of the response. Valid values:
9
9
  *
10
10
  * - zh: Chinese
11
11
  * - en: English
@@ -29,10 +29,12 @@ export class GetDashboardShrinkRequest extends $dara.Model {
29
29
  filterShrink?: string;
30
30
  /**
31
31
  * @remarks
32
- * The dashboard name. Valid values:
32
+ * The name of the dashboard. Valid values:
33
33
  *
34
- * - LOG: access log
35
- * - PLUGIN: plugin log
34
+ * - LOG: Access log.
35
+ * - PLUGIN: Plugin log.
36
+ *
37
+ * > Note: This parameter is required. If this parameter is not specified, the API returns InvalidParameter.IsEmpty (400).
36
38
  *
37
39
  * @example
38
40
  * PLUGIN
@@ -64,9 +66,11 @@ export class GetDashboardShrinkRequest extends $dara.Model {
64
66
  routeId?: string;
65
67
  /**
66
68
  * @remarks
67
- * The dashboard source. Valid values:
69
+ * The source of the dashboard. Valid values:
70
+ *
71
+ * - SLS: Log dashboard.
68
72
  *
69
- * - SLS: log dashboard
73
+ * > Note: This parameter is required. If this parameter is not specified, the API returns InvalidParameter.IsEmpty (400).
70
74
  *
71
75
  * @example
72
76
  * SLS
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The end time for querying consumption record details, in UNIX timestamp format (seconds). If only this parameter is specified, the system automatically calculates startTime based on the rule cycle.
8
+ * The end time for querying consumption record details. Specify a UNIX timestamp in seconds. If only this parameter is specified, the system automatically calculates startTime based on the rule cycle.
9
9
  *
10
10
  * @example
11
11
  * 1788425220
@@ -29,7 +29,7 @@ export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
29
29
  pageNumber?: number;
30
30
  /**
31
31
  * @remarks
32
- * The number of detailed consumption (request) records per page for the subject within the cycle. Maximum value: 10.
32
+ * The number of entries per page for the detailed consumption (request) records of the subject within the cycle. Maximum value: 10.
33
33
  *
34
34
  * @example
35
35
  * 10
@@ -37,7 +37,7 @@ export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
37
37
  pageSize?: number;
38
38
  /**
39
39
  * @remarks
40
- * The start time for querying consumption record details, in UNIX timestamp format (seconds). If only this parameter is specified, the system automatically calculates endTime based on the rule cycle.
40
+ * The start time for querying consumption record details. Specify a UNIX timestamp in seconds. If only this parameter is specified, the system automatically calculates endTime based on the rule cycle.
41
41
  *
42
42
  * @example
43
43
  * 1788338820
@@ -13,7 +13,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems extends
13
13
  cachedAmount?: number;
14
14
  /**
15
15
  * @remarks
16
- * The exact value of cached consumption. Supports decimals in credit scenarios.
16
+ * The exact value of cached consumption. Decimals are supported in credit scenarios.
17
17
  *
18
18
  * @example
19
19
  * 10.5
@@ -37,7 +37,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems extends
37
37
  inputAmount?: number;
38
38
  /**
39
39
  * @remarks
40
- * The exact value of input consumption. Supports decimals in credit scenarios.
40
+ * The exact value of input consumption. Decimals are supported in credit scenarios.
41
41
  *
42
42
  * @example
43
43
  * 120.5
@@ -61,7 +61,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems extends
61
61
  outputAmount?: number;
62
62
  /**
63
63
  * @remarks
64
- * The exact value of output consumption. Supports decimals in credit scenarios.
64
+ * The exact value of output consumption. Decimals are supported in credit scenarios.
65
65
  *
66
66
  * @example
67
67
  * 80.5
@@ -93,7 +93,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems extends
93
93
  usedAmount?: number;
94
94
  /**
95
95
  * @remarks
96
- * The exact value of total consumption. Supports decimals in credit scenarios.
96
+ * The exact value of total consumption. Decimals are supported in credit scenarios.
97
97
  *
98
98
  * @example
99
99
  * 210.5
@@ -216,7 +216,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model
216
216
  cachedAmount?: number;
217
217
  /**
218
218
  * @remarks
219
- * The exact value of total cached consumption. Supports decimals in credit scenarios.
219
+ * The exact value of total cached consumption. Decimals are supported in credit scenarios.
220
220
  *
221
221
  * @example
222
222
  * 20.5
@@ -240,7 +240,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model
240
240
  inputAmount?: number;
241
241
  /**
242
242
  * @remarks
243
- * The exact value of total input consumption. Supports decimals in credit scenarios.
243
+ * The exact value of total input consumption. Decimals are supported in credit scenarios.
244
244
  *
245
245
  * @example
246
246
  * 300.5
@@ -256,7 +256,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model
256
256
  outputAmount?: number;
257
257
  /**
258
258
  * @remarks
259
- * The exact value of total output consumption. Supports decimals in credit scenarios.
259
+ * The exact value of total output consumption. Decimals are supported in credit scenarios.
260
260
  *
261
261
  * @example
262
262
  * 180.5
@@ -304,7 +304,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model
304
304
  usedAmount?: number;
305
305
  /**
306
306
  * @remarks
307
- * The exact value of the total used amount of the subject. Supports decimals in credit scenarios.
307
+ * The exact value of the total used amount of the subject. Decimals are supported in credit scenarios.
308
308
  *
309
309
  * @example
310
310
  * 500.5
@@ -385,7 +385,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBody extends $dara.Model {
385
385
  message?: string;
386
386
  /**
387
387
  * @remarks
388
- * Id of the request
388
+ * The request ID.
389
389
  *
390
390
  * @example
391
391
  * 1234567890
@@ -0,0 +1,24 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class GetGatewayResourceQuotaUsageRequest extends $dara.Model {
6
+ static names(): { [key: string]: string } {
7
+ return {
8
+ };
9
+ }
10
+
11
+ static types(): { [key: string]: any } {
12
+ return {
13
+ };
14
+ }
15
+
16
+ validate() {
17
+ super.validate();
18
+ }
19
+
20
+ constructor(map?: { [key: string]: any }) {
21
+ super(map);
22
+ }
23
+ }
24
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { GetGatewayResourceQuotaUsageResponseBody } from "./GetGatewayResourceQuotaUsageResponseBody";
4
+
5
+
6
+ export class GetGatewayResourceQuotaUsageResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: GetGatewayResourceQuotaUsageResponseBody;
10
+ static names(): { [key: string]: string } {
11
+ return {
12
+ headers: 'headers',
13
+ statusCode: 'statusCode',
14
+ body: 'body',
15
+ };
16
+ }
17
+
18
+ static types(): { [key: string]: any } {
19
+ return {
20
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
21
+ statusCode: 'number',
22
+ body: GetGatewayResourceQuotaUsageResponseBody,
23
+ };
24
+ }
25
+
26
+ validate() {
27
+ if(this.headers) {
28
+ $dara.Model.validateMap(this.headers);
29
+ }
30
+ if(this.body && typeof (this.body as any).validate === 'function') {
31
+ (this.body as any).validate();
32
+ }
33
+ super.validate();
34
+ }
35
+
36
+ constructor(map?: { [key: string]: any }) {
37
+ super(map);
38
+ }
39
+ }
40
+
@@ -0,0 +1,200 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class GetGatewayResourceQuotaUsageResponseBodyDataItems extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * true 时返回 used 和 limit;false 时省略二者。CustomPlugin 当前固定为 false,仅表示暂时隐藏配额展示,不影响插件上传、安装或既有配额校验。其他项按网关能力及有效额度判定,不能仅凭本字段推断写入操作是否允许。
9
+ *
10
+ * @example
11
+ * true
12
+ */
13
+ applicable?: boolean;
14
+ /**
15
+ * @remarks
16
+ * 当前生效的非负整数配额上限,单位与 used 相同,已考虑现有配置、加白及适用的购买额度。仅 applicable=true 时返回,包括合法零值;示例不是所有网关的固定上限。
17
+ *
18
+ * @example
19
+ * 800
20
+ */
21
+ limit?: number;
22
+ /**
23
+ * @remarks
24
+ * GATEWAY 表示当前网关;ACCOUNT_GATEWAY_TYPE 表示当前账号、地域及网关类型的范围。仅 CustomPlugin 保留 ACCOUNT_GATEWAY_TYPE 标识;该项当前不读取或返回上限。
25
+ *
26
+ * @example
27
+ * GATEWAY
28
+ */
29
+ limitScope?: string;
30
+ /**
31
+ * @remarks
32
+ * 指标标识:Route(路由)、ConsumerAuthorizationRule(消费者授权规则)、McpServer(MCP Server)、Domain(域名)、Service(服务)、ConsumerQuotaRule(消费者配额规则)、K8sServiceSource(K8s 服务来源)、InstalledPlugin(已安装插件)、CustomPlugin(自定义插件)。
33
+ *
34
+ * @example
35
+ * Route
36
+ */
37
+ quotaKey?: string;
38
+ /**
39
+ * @remarks
40
+ * 实际占用数量,为非负整数,单位与 quotaKey 对应。仅 applicable=true 时返回;零值为真实零用量,历史超额可大于 limit,不截断。
41
+ *
42
+ * @example
43
+ * 12
44
+ */
45
+ used?: number;
46
+ /**
47
+ * @remarks
48
+ * GATEWAY 表示当前网关;ACCOUNT_REGION 表示当前账号在当前地域的共享范围。仅 CustomPlugin 保留 ACCOUNT_REGION 标识;该项当前不读取或返回用量。
49
+ *
50
+ * @example
51
+ * GATEWAY
52
+ */
53
+ usedScope?: string;
54
+ static names(): { [key: string]: string } {
55
+ return {
56
+ applicable: 'applicable',
57
+ limit: 'limit',
58
+ limitScope: 'limitScope',
59
+ quotaKey: 'quotaKey',
60
+ used: 'used',
61
+ usedScope: 'usedScope',
62
+ };
63
+ }
64
+
65
+ static types(): { [key: string]: any } {
66
+ return {
67
+ applicable: 'boolean',
68
+ limit: 'number',
69
+ limitScope: 'string',
70
+ quotaKey: 'string',
71
+ used: 'number',
72
+ usedScope: 'string',
73
+ };
74
+ }
75
+
76
+ validate() {
77
+ super.validate();
78
+ }
79
+
80
+ constructor(map?: { [key: string]: any }) {
81
+ super(map);
82
+ }
83
+ }
84
+
85
+ export class GetGatewayResourceQuotaUsageResponseBodyData extends $dara.Model {
86
+ /**
87
+ * @remarks
88
+ * 本次查询的目标网关唯一标识,与请求路径 gatewayId 一致。
89
+ *
90
+ * @example
91
+ * gw-d5be0s9q5z6f1234567g
92
+ */
93
+ gatewayId?: string;
94
+ /**
95
+ * @remarks
96
+ * 固定返回九项,每个 quotaKey 仅出现一次。不适用或暂不展示的项仍保留,applicable=false 且省略 used/limit。不返回剩余额度或百分比;示例数值不是固定默认上限。
97
+ *
98
+ * @example
99
+ * [{"quotaKey":"Route","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":12,"limit":800},{"quotaKey":"ConsumerAuthorizationRule","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":20,"limit":1000},{"quotaKey":"McpServer","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":false},{"quotaKey":"Domain","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":2,"limit":100},{"quotaKey":"Service","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":5,"limit":800},{"quotaKey":"ConsumerQuotaRule","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":0,"limit":1000},{"quotaKey":"K8sServiceSource","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":1,"limit":3},{"quotaKey":"InstalledPlugin","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":2,"limit":5},{"quotaKey":"CustomPlugin","usedScope":"ACCOUNT_REGION","limitScope":"ACCOUNT_GATEWAY_TYPE","applicable":false}]
100
+ */
101
+ items?: GetGatewayResourceQuotaUsageResponseBodyDataItems[];
102
+ /**
103
+ * @remarks
104
+ * 服务端完成本次统计的 UTC 时间,格式为 RFC 3339,可包含小数秒。各来源独立读取,不保证跨来源瞬时原子快照。
105
+ *
106
+ * @example
107
+ * 2026-09-17T08:00:00Z
108
+ */
109
+ observedAt?: string;
110
+ static names(): { [key: string]: string } {
111
+ return {
112
+ gatewayId: 'gatewayId',
113
+ items: 'items',
114
+ observedAt: 'observedAt',
115
+ };
116
+ }
117
+
118
+ static types(): { [key: string]: any } {
119
+ return {
120
+ gatewayId: 'string',
121
+ items: { 'type': 'array', 'itemType': GetGatewayResourceQuotaUsageResponseBodyDataItems },
122
+ observedAt: 'string',
123
+ };
124
+ }
125
+
126
+ validate() {
127
+ if(Array.isArray(this.items)) {
128
+ $dara.Model.validateArray(this.items);
129
+ }
130
+ super.validate();
131
+ }
132
+
133
+ constructor(map?: { [key: string]: any }) {
134
+ super(map);
135
+ }
136
+ }
137
+
138
+ export class GetGatewayResourceQuotaUsageResponseBody extends $dara.Model {
139
+ /**
140
+ * @remarks
141
+ * 业务响应码。成功时为 Ok;失败时为具体错误码,应结合 HTTP 状态码处理。
142
+ *
143
+ * @example
144
+ * Ok
145
+ */
146
+ code?: string;
147
+ /**
148
+ * @remarks
149
+ * 目标网关及其九项资源配额观测结果。示例数值只说明格式,实际有效上限以本次响应为准。
150
+ *
151
+ * @example
152
+ * {"gatewayId":"gw-d5be0s9q5z6f1234567g","observedAt":"2026-09-17T08:00:00Z","items":[{"quotaKey":"Route","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":12,"limit":800},{"quotaKey":"ConsumerAuthorizationRule","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":20,"limit":1000},{"quotaKey":"McpServer","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":false},{"quotaKey":"Domain","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":2,"limit":100},{"quotaKey":"Service","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":5,"limit":800},{"quotaKey":"ConsumerQuotaRule","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":0,"limit":1000},{"quotaKey":"K8sServiceSource","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":1,"limit":3},{"quotaKey":"InstalledPlugin","usedScope":"GATEWAY","limitScope":"GATEWAY","applicable":true,"used":2,"limit":5},{"quotaKey":"CustomPlugin","usedScope":"ACCOUNT_REGION","limitScope":"ACCOUNT_GATEWAY_TYPE","applicable":false}]}
153
+ */
154
+ data?: GetGatewayResourceQuotaUsageResponseBodyData;
155
+ /**
156
+ * @remarks
157
+ * 失败时返回的错误说明,成功响应通常省略本字段。示例为错误信息,不是成功响应。
158
+ *
159
+ * @example
160
+ * The specified gateway does not exist.
161
+ */
162
+ message?: string;
163
+ /**
164
+ * @remarks
165
+ * 请求的唯一标识,用于排查问题。
166
+ *
167
+ * @example
168
+ * D0A6A1A0-8793-4C10-AB1A-2C03E770A912
169
+ */
170
+ requestId?: string;
171
+ static names(): { [key: string]: string } {
172
+ return {
173
+ code: 'code',
174
+ data: 'data',
175
+ message: 'message',
176
+ requestId: 'requestId',
177
+ };
178
+ }
179
+
180
+ static types(): { [key: string]: any } {
181
+ return {
182
+ code: 'string',
183
+ data: GetGatewayResourceQuotaUsageResponseBodyData,
184
+ message: 'string',
185
+ requestId: 'string',
186
+ };
187
+ }
188
+
189
+ validate() {
190
+ if(this.data && typeof (this.data as any).validate === 'function') {
191
+ (this.data as any).validate();
192
+ }
193
+ super.validate();
194
+ }
195
+
196
+ constructor(map?: { [key: string]: any }) {
197
+ super(map);
198
+ }
199
+ }
200
+
@@ -21,7 +21,7 @@ export class UpdateConsumerAuthorizationRuleResponseBody extends $dara.Model {
21
21
  message?: string;
22
22
  /**
23
23
  * @remarks
24
- * Id of the request
24
+ * The request ID.
25
25
  *
26
26
  * @example
27
27
  * C67DED2B-F19B-5BEC-88C1-D6EB854CD0D4
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The list of consumer principal IDs to bind.
8
+ * The list of consumer subject IDs to bind.
9
9
  *
10
10
  * @example
11
11
  * cs-001,cs-002
@@ -13,11 +13,11 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
13
13
  addIds?: string[];
14
14
  /**
15
15
  * @remarks
16
- * The conflict snapshot hash, used to prevent concurrent dirty overwrites when confirming an overwrite. Obtain this value from the response of a prior dryRun=true call.
16
+ * The conflict snapshot hash, used to prevent concurrent dirty overwrites when confirming an overwrite. Obtain this value from the response of a dry run request with dryRun set to true.
17
17
  *
18
18
  * This parameter is not required in the following cases: no conflicts exist, the request is a dry run (dryRun=true), or overwrite is set to false.
19
19
  *
20
- * When dryRun is set to false and overwrite is set to true, if this parameter is missing or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. Perform a dry run again to confirm the new conflicts.
20
+ * If dryRun is set to false and overwrite is set to true but this parameter is missing or the value has expired, the backend returns accepted=false with a new conflict preview. Perform a new dry run to confirm the updated conflicts.
21
21
  *
22
22
  * @example
23
23
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541f50xxxxxx
@@ -35,7 +35,7 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
35
35
  consumerGroupIds?: string[];
36
36
  /**
37
37
  * @remarks
38
- * Specifies whether to perform a dry run only without persisting or applying the configuration. A dry run checks whether conflicting rules exist on the bound consumer principals. The same consumer principal cannot have two calendar-period quotas with the same period. For example, a consumer principal that already has a daily calendar quota cannot be assigned another daily calendar quota rule.
38
+ * Specifies whether to perform only a dry run without applying the actual configuration. A dry run checks whether conflicting rules exist on the bound API consumer. The same API consumer cannot have two natural period quotas with the same period. For example, you cannot add a calendar day quota rule to an API consumer that already has a calendar day quota rule.
39
39
  *
40
40
  * @example
41
41
  * true
@@ -43,12 +43,12 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
43
43
  dryRun?: boolean;
44
44
  /**
45
45
  * @remarks
46
- * Specifies whether to allow overwriting when conflicts exist. If overwriting is allowed, conflicting principals (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
46
+ * Specifies whether to allow overwriting when conflicts exist. If overwriting is allowed, conflicting subjects (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
47
47
  */
48
48
  overwrite?: boolean;
49
49
  /**
50
50
  * @remarks
51
- * The updated total available quota.
51
+ * The updated total available quota per period.
52
52
  *
53
53
  * @example
54
54
  * 1000
@@ -56,7 +56,7 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
56
56
  quotaLimit?: number;
57
57
  /**
58
58
  * @remarks
59
- * The list of consumer principal IDs to unbind.
59
+ * The list of consumer subject IDs to unbind.
60
60
  *
61
61
  * @example
62
62
  * cs003,cs-004
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The period type of the existing conflicting rule on the consumer principal. Valid values: day, week, and month, which indicate that the period of the conflicting rule is daily, weekly, or monthly.
8
+ * The period type of the existing conflicting rule on the consumer subject. Valid values: day (daily), week (weekly), month (monthly).
9
9
  *
10
10
  * @example
11
11
  * week
@@ -13,7 +13,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
13
13
  conflictPeriodType?: string;
14
14
  /**
15
15
  * @remarks
16
- * The type of the existing conflicting rule on the consumer principal. Valid values: calendar (the conflicting rule uses a calendar period) and epoch (the conflicting rule uses a custom period).
16
+ * The type of the existing conflicting rule on the consumer subject. Valid values: calendar (calendar period) and epoch (custom period).
17
17
  *
18
18
  * @example
19
19
  * calendar
@@ -21,7 +21,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
21
21
  conflictType?: string;
22
22
  /**
23
23
  * @remarks
24
- * The consumer ID. You can use subjectId instead.
24
+ * The consumer ID. Use subjectId instead.
25
25
  *
26
26
  * @example
27
27
  * cs-d82n1g6m1hkm375xxxxx
@@ -29,7 +29,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
29
29
  consumerId?: string;
30
30
  /**
31
31
  * @remarks
32
- * The consumer name. You can use subjectName instead.
32
+ * The consumer name. Use subjectName instead.
33
33
  *
34
34
  * @example
35
35
  * consumer-a
@@ -37,7 +37,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
37
37
  consumerName?: string;
38
38
  /**
39
39
  * @remarks
40
- * The ID of the conflicting principal.
40
+ * The ID of the conflicting subject.
41
41
  *
42
42
  * @example
43
43
  * cs-xxx
@@ -45,7 +45,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
45
45
  subjectId?: string;
46
46
  /**
47
47
  * @remarks
48
- * The name of the conflicting principal.
48
+ * The name of the conflicting subject.
49
49
  *
50
50
  * @example
51
51
  * consumer-a
@@ -53,7 +53,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
53
53
  subjectName?: string;
54
54
  /**
55
55
  * @remarks
56
- * The type of the conflicting principal. Valid values: consumer and consumer_group.
56
+ * The type of the conflicting subject. Valid values: consumer and consumer_group.
57
57
  *
58
58
  * @example
59
59
  * consumer
@@ -95,7 +95,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
95
95
  export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
96
96
  /**
97
97
  * @remarks
98
- * The hash of the conflict snapshot.
98
+ * The conflict hash.
99
99
  *
100
100
  * @example
101
101
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541f50xxxxxx
@@ -103,7 +103,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara
103
103
  conflictHash?: string;
104
104
  /**
105
105
  * @remarks
106
- * The list of conflicting principals (consumers or consumer groups).
106
+ * The list of conflicting subjects (consumers or consumer groups).
107
107
  */
108
108
  items?: UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
109
109
  /**
@@ -145,7 +145,7 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara
145
145
  export class UpdateGatewayQuotaRuleResponseBodyData extends $dara.Model {
146
146
  /**
147
147
  * @remarks
148
- * Indicates whether the write request is accepted by the system. A value of false typically indicates a retryable scenario such as an unconfirmed conflict overwrite.
148
+ * Indicates whether the write request is accepted by the system. A value of false typically indicates a retryable scenario, such as an unconfirmed conflict overwrite.
149
149
  *
150
150
  * @example
151
151
  * true
@@ -158,7 +158,7 @@ export class UpdateGatewayQuotaRuleResponseBodyData extends $dara.Model {
158
158
  conflictPreview?: UpdateGatewayQuotaRuleResponseBodyDataConflictPreview;
159
159
  /**
160
160
  * @remarks
161
- * Indicates whether the request is a dry run.
161
+ * Indicates whether this is a dry run.
162
162
  *
163
163
  * @example
164
164
  * true
@@ -213,7 +213,7 @@ export class UpdateGatewayQuotaRuleResponseBody extends $dara.Model {
213
213
  code?: string;
214
214
  /**
215
215
  * @remarks
216
- * The response data content.
216
+ * The response data.
217
217
  *
218
218
  * @example
219
219
  * {\\"key\\": \\"value\\"}
@@ -221,7 +221,7 @@ export class UpdateGatewayQuotaRuleResponseBody extends $dara.Model {
221
221
  data?: UpdateGatewayQuotaRuleResponseBodyData;
222
222
  /**
223
223
  * @remarks
224
- * The message content.
224
+ * The response message.
225
225
  *
226
226
  * @example
227
227
  * Hello, World!