@alicloud/apig20240327 11.2.0 → 11.3.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 (57) hide show
  1. package/dist/client.d.ts +82 -58
  2. package/dist/client.js +115 -58
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddGatewayQuotaRuleRequest.d.ts +20 -14
  5. package/dist/models/AddGatewayQuotaRuleRequest.js.map +1 -1
  6. package/dist/models/AddGatewayQuotaRuleResponseBody.d.ts +14 -9
  7. package/dist/models/AddGatewayQuotaRuleResponseBody.js.map +1 -1
  8. package/dist/models/GetDashboardRequest.d.ts +5 -5
  9. package/dist/models/GetDashboardResponseBody.d.ts +2 -2
  10. package/dist/models/GetDashboardShrinkRequest.d.ts +5 -5
  11. package/dist/models/GetGatewayQuotaRuleRequest.d.ts +4 -4
  12. package/dist/models/GetGatewayQuotaRuleResponseBody.d.ts +4 -4
  13. package/dist/models/GetGatewayQuotaRuleSubjectUsageRequest.d.ts +3 -3
  14. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.d.ts +1 -1
  15. package/dist/models/HttpApiApiInfo.d.ts +1 -1
  16. package/dist/models/HttpApiApiInfoDeployCntMapValue.d.ts +1 -1
  17. package/dist/models/HttpRoute.d.ts +4 -1
  18. package/dist/models/HttpRoute.js.map +1 -1
  19. package/dist/models/ListConsumerGroupQuotaRulesRequest.d.ts +33 -0
  20. package/dist/models/ListConsumerGroupQuotaRulesRequest.js +64 -0
  21. package/dist/models/ListConsumerGroupQuotaRulesRequest.js.map +1 -0
  22. package/dist/models/ListConsumerGroupQuotaRulesResponse.d.ts +19 -0
  23. package/dist/models/ListConsumerGroupQuotaRulesResponse.js +69 -0
  24. package/dist/models/ListConsumerGroupQuotaRulesResponse.js.map +1 -0
  25. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.d.ts +132 -0
  26. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.js +134 -0
  27. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.js.map +1 -0
  28. package/dist/models/ResetGatewayQuotaRuleRequest.d.ts +9 -10
  29. package/dist/models/ResetGatewayQuotaRuleRequest.js.map +1 -1
  30. package/dist/models/ResetGatewayQuotaRuleResponseBody.d.ts +16 -16
  31. package/dist/models/UpdateGatewayQuotaRuleRequest.d.ts +8 -8
  32. package/dist/models/UpdateGatewayQuotaRuleResponseBody.d.ts +12 -12
  33. package/dist/models/model.d.ts +5 -0
  34. package/dist/models/model.js +26 -16
  35. package/dist/models/model.js.map +1 -1
  36. package/package.json +1 -1
  37. package/src/client.ts +121 -58
  38. package/src/models/AddGatewayQuotaRuleRequest.ts +20 -14
  39. package/src/models/AddGatewayQuotaRuleResponseBody.ts +14 -9
  40. package/src/models/GetDashboardRequest.ts +5 -5
  41. package/src/models/GetDashboardResponseBody.ts +2 -2
  42. package/src/models/GetDashboardShrinkRequest.ts +5 -5
  43. package/src/models/GetGatewayQuotaRuleRequest.ts +4 -4
  44. package/src/models/GetGatewayQuotaRuleResponseBody.ts +4 -4
  45. package/src/models/GetGatewayQuotaRuleSubjectUsageRequest.ts +3 -3
  46. package/src/models/GetGatewayQuotaRuleSubjectUsageResponseBody.ts +1 -1
  47. package/src/models/HttpApiApiInfo.ts +1 -1
  48. package/src/models/HttpApiApiInfoDeployCntMapValue.ts +1 -1
  49. package/src/models/HttpRoute.ts +4 -1
  50. package/src/models/ListConsumerGroupQuotaRulesRequest.ts +52 -0
  51. package/src/models/ListConsumerGroupQuotaRulesResponse.ts +40 -0
  52. package/src/models/ListConsumerGroupQuotaRulesResponseBody.ts +203 -0
  53. package/src/models/ResetGatewayQuotaRuleRequest.ts +9 -10
  54. package/src/models/ResetGatewayQuotaRuleResponseBody.ts +16 -16
  55. package/src/models/UpdateGatewayQuotaRuleRequest.ts +8 -8
  56. package/src/models/UpdateGatewayQuotaRuleResponseBody.ts +12 -12
  57. package/src/models/model.ts +5 -0
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetGatewayQuotaRuleResponseBodyDataConsumers extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The subject (consumer) ID.
8
+ * The subject (API consumer) ID.
9
9
  *
10
10
  * @example
11
11
  * c-aaa
@@ -13,7 +13,7 @@ export class GetGatewayQuotaRuleResponseBodyDataConsumers extends $dara.Model {
13
13
  id?: string;
14
14
  /**
15
15
  * @remarks
16
- * The subject (consumer) name.
16
+ * The subject (API consumer) name.
17
17
  *
18
18
  * @example
19
19
  * consumer-a
@@ -103,7 +103,7 @@ export class GetGatewayQuotaRuleResponseBodyData extends $dara.Model {
103
103
  baseTimestamp?: number;
104
104
  /**
105
105
  * @remarks
106
- * The number of consumers associated with the rule.
106
+ * The number of API consumers associated with the rule.
107
107
  *
108
108
  * @example
109
109
  * 20
@@ -111,7 +111,7 @@ export class GetGatewayQuotaRuleResponseBodyData extends $dara.Model {
111
111
  consumerCount?: number;
112
112
  /**
113
113
  * @remarks
114
- * The list of subjects (consumers) bound to this rule.
114
+ * The list of subjects (API consumers) bound to this rule.
115
115
  */
116
116
  consumers?: GetGatewayQuotaRuleResponseBodyDataConsumers[];
117
117
  /**
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * Specifies whether to filter zero values.
8
+ * Specifies whether to filter out zero values.
9
9
  *
10
10
  * @example
11
11
  * true
@@ -13,7 +13,7 @@ export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
13
13
  filterFailedRequests?: boolean;
14
14
  /**
15
15
  * @remarks
16
- * The page number of the detailed consumption (request) records of the consumer within the cycle.
16
+ * The page number of the detailed consumption (request) records of the subject within the cycle.
17
17
  *
18
18
  * @example
19
19
  * 1
@@ -21,7 +21,7 @@ export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
21
21
  pageNumber?: number;
22
22
  /**
23
23
  * @remarks
24
- * The number of detailed consumption (request) records per page for the consumer within the cycle. Maximum value: 10.
24
+ * The number of detailed consumption (request) records per page for the subject within the cycle. Maximum value: 10.
25
25
  *
26
26
  * @example
27
27
  * 10
@@ -226,7 +226,7 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model
226
226
  totalQuota?: number;
227
227
  /**
228
228
  * @remarks
229
- * The total used quota of the subject.
229
+ * The total used amount of the subject.
230
230
  *
231
231
  * @example
232
232
  * 500
@@ -501,7 +501,7 @@ export class HttpApiApiInfo extends $dara.Model {
501
501
  basePath?: string;
502
502
  /**
503
503
  * @remarks
504
- * The API operation publish status.
504
+ * The API operation deployment status.
505
505
  */
506
506
  deployCntMap?: { [key: string]: HttpApiApiInfoDeployCntMapValue };
507
507
  /**
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class HttpApiApiInfoDeployCntMapValue extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The number of published API operations.
8
+ * The number of deployed API operations.
9
9
  *
10
10
  * @example
11
11
  * 3
@@ -56,6 +56,9 @@ export class HttpRouteDomainInfos extends $dara.Model {
56
56
 
57
57
  export class HttpRouteEnvironmentInfoGatewayInfo extends $dara.Model {
58
58
  /**
59
+ * @remarks
60
+ * The gateway instance edition. Valid values: Professional, Serverless, MultiTenantServerless, and Unknown.
61
+ *
59
62
  * @example
60
63
  * MultiTenantServerless
61
64
  */
@@ -359,7 +362,7 @@ export class HttpRoute extends $dara.Model {
359
362
  backend?: Backend;
360
363
  /**
361
364
  * @remarks
362
- * Indicates whether the route is a built-in system route.
365
+ * Indicates whether the route is a system built-in route.
363
366
  *
364
367
  * @example
365
368
  * true
@@ -0,0 +1,52 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class ListConsumerGroupQuotaRulesRequest extends $dara.Model {
6
+ /**
7
+ * @example
8
+ * gw-123456
9
+ */
10
+ gatewayId?: string;
11
+ /**
12
+ * @example
13
+ * daily
14
+ */
15
+ keyword?: string;
16
+ /**
17
+ * @example
18
+ * 1
19
+ */
20
+ pageNumber?: number;
21
+ /**
22
+ * @example
23
+ * 10
24
+ */
25
+ pageSize?: number;
26
+ static names(): { [key: string]: string } {
27
+ return {
28
+ gatewayId: 'gatewayId',
29
+ keyword: 'keyword',
30
+ pageNumber: 'pageNumber',
31
+ pageSize: 'pageSize',
32
+ };
33
+ }
34
+
35
+ static types(): { [key: string]: any } {
36
+ return {
37
+ gatewayId: 'string',
38
+ keyword: 'string',
39
+ pageNumber: 'number',
40
+ pageSize: 'number',
41
+ };
42
+ }
43
+
44
+ validate() {
45
+ super.validate();
46
+ }
47
+
48
+ constructor(map?: { [key: string]: any }) {
49
+ super(map);
50
+ }
51
+ }
52
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { ListConsumerGroupQuotaRulesResponseBody } from "./ListConsumerGroupQuotaRulesResponseBody";
4
+
5
+
6
+ export class ListConsumerGroupQuotaRulesResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: ListConsumerGroupQuotaRulesResponseBody;
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: ListConsumerGroupQuotaRulesResponseBody,
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,203 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class ListConsumerGroupQuotaRulesResponseBodyDataItems extends $dara.Model {
6
+ /**
7
+ * @example
8
+ * gw-123456
9
+ */
10
+ gatewayId?: string;
11
+ /**
12
+ * @example
13
+ * prod-gateway
14
+ */
15
+ gatewayName?: string;
16
+ /**
17
+ * @example
18
+ * 30
19
+ */
20
+ periodMultiplier?: number;
21
+ /**
22
+ * @example
23
+ * week
24
+ */
25
+ periodType?: string;
26
+ /**
27
+ * @example
28
+ * token
29
+ */
30
+ quotaDimension?: string;
31
+ /**
32
+ * @example
33
+ * 1000
34
+ */
35
+ quotaLimit?: number;
36
+ /**
37
+ * @example
38
+ * rule-001
39
+ */
40
+ ruleId?: string;
41
+ /**
42
+ * @example
43
+ * daily-token-limit
44
+ */
45
+ ruleName?: string;
46
+ /**
47
+ * @example
48
+ * enabled
49
+ */
50
+ ruleStatus?: string;
51
+ /**
52
+ * @example
53
+ * UTC+8
54
+ */
55
+ timezone?: string;
56
+ /**
57
+ * @example
58
+ * calendar
59
+ */
60
+ windowAlignment?: string;
61
+ static names(): { [key: string]: string } {
62
+ return {
63
+ gatewayId: 'gatewayId',
64
+ gatewayName: 'gatewayName',
65
+ periodMultiplier: 'periodMultiplier',
66
+ periodType: 'periodType',
67
+ quotaDimension: 'quotaDimension',
68
+ quotaLimit: 'quotaLimit',
69
+ ruleId: 'ruleId',
70
+ ruleName: 'ruleName',
71
+ ruleStatus: 'ruleStatus',
72
+ timezone: 'timezone',
73
+ windowAlignment: 'windowAlignment',
74
+ };
75
+ }
76
+
77
+ static types(): { [key: string]: any } {
78
+ return {
79
+ gatewayId: 'string',
80
+ gatewayName: 'string',
81
+ periodMultiplier: 'number',
82
+ periodType: 'string',
83
+ quotaDimension: 'string',
84
+ quotaLimit: 'number',
85
+ ruleId: 'string',
86
+ ruleName: 'string',
87
+ ruleStatus: 'string',
88
+ timezone: 'string',
89
+ windowAlignment: 'string',
90
+ };
91
+ }
92
+
93
+ validate() {
94
+ super.validate();
95
+ }
96
+
97
+ constructor(map?: { [key: string]: any }) {
98
+ super(map);
99
+ }
100
+ }
101
+
102
+ export class ListConsumerGroupQuotaRulesResponseBodyData extends $dara.Model {
103
+ /**
104
+ * @example
105
+ * [{"ruleId":"rule-001"}]
106
+ */
107
+ items?: ListConsumerGroupQuotaRulesResponseBodyDataItems[];
108
+ /**
109
+ * @example
110
+ * 1
111
+ */
112
+ pageNumber?: number;
113
+ /**
114
+ * @example
115
+ * 10
116
+ */
117
+ pageSize?: number;
118
+ /**
119
+ * @example
120
+ * 100
121
+ */
122
+ totalSize?: number;
123
+ static names(): { [key: string]: string } {
124
+ return {
125
+ items: 'items',
126
+ pageNumber: 'pageNumber',
127
+ pageSize: 'pageSize',
128
+ totalSize: 'totalSize',
129
+ };
130
+ }
131
+
132
+ static types(): { [key: string]: any } {
133
+ return {
134
+ items: { 'type': 'array', 'itemType': ListConsumerGroupQuotaRulesResponseBodyDataItems },
135
+ pageNumber: 'number',
136
+ pageSize: 'number',
137
+ totalSize: 'number',
138
+ };
139
+ }
140
+
141
+ validate() {
142
+ if(Array.isArray(this.items)) {
143
+ $dara.Model.validateArray(this.items);
144
+ }
145
+ super.validate();
146
+ }
147
+
148
+ constructor(map?: { [key: string]: any }) {
149
+ super(map);
150
+ }
151
+ }
152
+
153
+ export class ListConsumerGroupQuotaRulesResponseBody extends $dara.Model {
154
+ /**
155
+ * @example
156
+ * 200
157
+ */
158
+ code?: string;
159
+ /**
160
+ * @example
161
+ * {"totalSize":100}
162
+ */
163
+ data?: ListConsumerGroupQuotaRulesResponseBodyData;
164
+ /**
165
+ * @example
166
+ * success
167
+ */
168
+ message?: string;
169
+ /**
170
+ * @example
171
+ * 1234567890
172
+ */
173
+ requestId?: string;
174
+ static names(): { [key: string]: string } {
175
+ return {
176
+ code: 'code',
177
+ data: 'data',
178
+ message: 'message',
179
+ requestId: 'requestId',
180
+ };
181
+ }
182
+
183
+ static types(): { [key: string]: any } {
184
+ return {
185
+ code: 'string',
186
+ data: ListConsumerGroupQuotaRulesResponseBodyData,
187
+ message: 'string',
188
+ requestId: 'string',
189
+ };
190
+ }
191
+
192
+ validate() {
193
+ if(this.data && typeof (this.data as any).validate === 'function') {
194
+ (this.data as any).validate();
195
+ }
196
+ super.validate();
197
+ }
198
+
199
+ constructor(map?: { [key: string]: any }) {
200
+ super(map);
201
+ }
202
+ }
203
+
@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class ResetGatewayQuotaRuleRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The conflict snapshot hash, used to prevent concurrent dirty overwrites when confirming an overwrite. Obtain this value from the response of a dryRun=true request.
8
+ * The conflict snapshot hash, used to prevent concurrent dirty overwrites when confirming an overwrite. Obtain this value from the response of a previous dryRun=true call.
9
9
  *
10
- * This parameter is not required in the following cases: no conflict exists, the request is a dry run (dryRun=true), or overwrite=false (overwrite not confirmed).
10
+ * You do not need to specify this parameter in the following cases: no conflicts exist, you are performing a dry run (dryRun=true), or you are not confirming an overwrite (overwrite=false).
11
11
  *
12
- * When dryRun=false and overwrite=true, if this parameter is not provided or the value has expired and does not match, the backend returns accepted=false with a new conflict preview. You must perform a dry run again to confirm the new conflict.
12
+ * When dryRun is set to false and overwrite is set to true, if this parameter is not specified or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. You must perform the dry run again to confirm the new conflicts.
13
13
  *
14
14
  * @example
15
15
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
@@ -17,7 +17,7 @@ export class ResetGatewayQuotaRuleRequest extends $dara.Model {
17
17
  conflictHash?: string;
18
18
  /**
19
19
  * @remarks
20
- * Specifies whether to perform only a dry run without delivering the actual configuration. A dry run checks whether conflicting rules exist on the bound consumers. For example, a consumer that already has a calendar-day quota cannot have another calendar-day quota rule added.
20
+ * Specifies whether to perform only a dry run without persisting or applying the configuration. A dry run checks whether conflicting rules exist on the bound subjects. The same subject cannot have two calendar-period quotas with the same period. For example, a subject that already has a daily calendar quota cannot have another daily calendar quota rule added.
21
21
  *
22
22
  * @example
23
23
  * false
@@ -25,7 +25,7 @@ export class ResetGatewayQuotaRuleRequest extends $dara.Model {
25
25
  dryRun?: boolean;
26
26
  /**
27
27
  * @remarks
28
- * Specifies whether to allow overwriting on conflict. If overwriting is allowed, the conflicting subject (consumer) is unbound from the old rule and bound to the new rule.
28
+ * Specifies whether to allow overwriting when conflicts exist. If you allow overwriting, the conflicting subjects (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
29
29
  *
30
30
  * @example
31
31
  * false
@@ -33,7 +33,7 @@ export class ResetGatewayQuotaRuleRequest extends $dara.Model {
33
33
  overwrite?: boolean;
34
34
  /**
35
35
  * @remarks
36
- * The period multiplier. Specifies how many periods elapse before the quota resets. Returned when the rule uses a custom period. Minimum value: 1. Maximum value: 60.
36
+ * The period multiplier, which specifies the number of periods after which the quota is reset. This parameter is returned when the rule uses a custom period. Minimum value: 1. Maximum value: 60.
37
37
  *
38
38
  * @example
39
39
  * 1
@@ -57,7 +57,7 @@ export class ResetGatewayQuotaRuleRequest extends $dara.Model {
57
57
  quotaLimit?: number;
58
58
  /**
59
59
  * @remarks
60
- * The time zone for the calendar period in UTC+x format.
60
+ * The time zone for the calendar period, in UTC+x format.
61
61
  *
62
62
  * @example
63
63
  * UTC+8
@@ -65,10 +65,9 @@ export class ResetGatewayQuotaRuleRequest extends $dara.Model {
65
65
  timezone?: string;
66
66
  /**
67
67
  * @remarks
68
- * The period type after the reset. Valid values:
69
- *
68
+ * The period alignment type after the reset. Valid values:
70
69
  * - calendar: calendar period.
71
- * - epoch: custom period. Custom periods are supported only on dedicated instances with version 2.1.19 or later.
70
+ * - epoch: custom period.
72
71
  *
73
72
  * @example
74
73
  * calendar
@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The period type of the existing conflicting rule on the consumer. Valid values:
9
- *
10
- * - day: daily.
11
- * - week: weekly.
12
- * - month: monthly.
8
+ * The period type of the existing conflicting rule on the subject. Valid values:
9
+ * - day: The period of the existing conflicting rule is daily.
10
+ * - week: The period of the existing conflicting rule is weekly.
11
+ * - month: The period of the existing conflicting rule is monthly.
13
12
  *
14
13
  * @example
15
14
  * week
@@ -17,10 +16,9 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $
17
16
  conflictPeriodType?: string;
18
17
  /**
19
18
  * @remarks
20
- * The type of the existing conflicting rule on the consumer. Valid values:
21
- *
22
- * - calendar: the existing conflicting rule uses a calendar period.
23
- * - epoch: the existing conflicting rule uses a custom period.
19
+ * The type of the existing conflicting rule on the subject. Valid values:
20
+ * - calendar: The existing conflicting rule uses a calendar period.
21
+ * - epoch: The existing conflicting rule uses a custom period.
24
22
  *
25
23
  * @example
26
24
  * calendar
@@ -28,7 +26,7 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $
28
26
  conflictType?: string;
29
27
  /**
30
28
  * @remarks
31
- * The consumer ID.
29
+ * The consumer ID. You can use subjectId instead.
32
30
  *
33
31
  * @example
34
32
  * cs-d82n1g6m1hkm3xxxxxxx
@@ -36,7 +34,7 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $
36
34
  consumerId?: string;
37
35
  /**
38
36
  * @remarks
39
- * The consumer name.
37
+ * The consumer name. You can use subjectName instead.
40
38
  *
41
39
  * @example
42
40
  * consumer-a
@@ -60,7 +58,9 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $
60
58
  subjectName?: string;
61
59
  /**
62
60
  * @remarks
63
- * The conflict subject type. Valid values: consumer and consumer_group.
61
+ * The type of the conflicting subject. Valid values:
62
+ * - consumer
63
+ * - consumer_group
64
64
  *
65
65
  * @example
66
66
  * consumer
@@ -110,7 +110,7 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.
110
110
  conflictHash?: string;
111
111
  /**
112
112
  * @remarks
113
- * The list of conflicting subjects (consumers).
113
+ * The list of conflicting subjects.
114
114
  */
115
115
  items?: ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
116
116
  /**
@@ -152,7 +152,7 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.
152
152
  export class ResetGatewayQuotaRuleResponseBodyData extends $dara.Model {
153
153
  /**
154
154
  * @remarks
155
- * 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.
155
+ * 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.
156
156
  *
157
157
  * @example
158
158
  * true
@@ -228,7 +228,7 @@ export class ResetGatewayQuotaRuleResponseBody extends $dara.Model {
228
228
  data?: ResetGatewayQuotaRuleResponseBodyData;
229
229
  /**
230
230
  * @remarks
231
- * The message content.
231
+ * The message.
232
232
  *
233
233
  * @example
234
234
  * Hello, World!
@@ -236,7 +236,7 @@ export class ResetGatewayQuotaRuleResponseBody extends $dara.Model {
236
236
  message?: string;
237
237
  /**
238
238
  * @remarks
239
- * The unique identifier of the request.
239
+ * The request ID.
240
240
  *
241
241
  * @example
242
242
  * 1234567890
@@ -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 subject (consumer) IDs to bind.
8
+ * The list of consumer principal 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 during confirmation. 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 prior dryRun=true call.
17
17
  *
18
- * This parameter is not required in the following cases: no conflict exists, the request is a dry run (dryRun=true), or overwrite is set to false.
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=false and overwrite=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. You must perform a dry run again to confirm the new conflict.
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.
21
21
  *
22
22
  * @example
23
23
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541f50xxxxxx
@@ -25,7 +25,7 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
25
25
  conflictHash?: string;
26
26
  /**
27
27
  * @remarks
28
- * The list of consumer group IDs. This parameter is not supported currently.
28
+ * **[Deprecated]** The list of consumer group IDs.
29
29
  *
30
30
  * @example
31
31
  * group1,group2
@@ -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 consumers. The same consumer cannot have two quota rules with the same calendar period. For example, a consumer that already has a daily calendar quota cannot be assigned another daily calendar quota rule.
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.
39
39
  *
40
40
  * @example
41
41
  * true
@@ -43,7 +43,7 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
43
43
  dryRun?: boolean;
44
44
  /**
45
45
  * @remarks
46
- * Specifies whether to allow overwriting on conflict. If overwriting is allowed, conflicting subjects (consumers) 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 principals (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
47
47
  */
48
48
  overwrite?: boolean;
49
49
  /**
@@ -56,7 +56,7 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
56
56
  quotaLimit?: number;
57
57
  /**
58
58
  * @remarks
59
- * The list of subject (consumer) IDs to unbind.
59
+ * The list of consumer principal IDs to unbind.
60
60
  *
61
61
  * @example
62
62
  * cs003,cs-004