@alicloud/apig20240327 11.3.2 → 11.3.3

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 (66) hide show
  1. package/dist/client.d.ts +24 -24
  2. package/dist/client.js +32 -24
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddGatewayQuotaRuleRequest.d.ts +16 -16
  5. package/dist/models/AddGatewayQuotaRuleResponseBody.d.ts +6 -11
  6. package/dist/models/AddGatewayQuotaRuleResponseBody.js.map +1 -1
  7. package/dist/models/CreateConsumerRequest.d.ts +16 -4
  8. package/dist/models/CreateConsumerRequest.js +4 -0
  9. package/dist/models/CreateConsumerRequest.js.map +1 -1
  10. package/dist/models/CreateHttpApiRequest.d.ts +28 -14
  11. package/dist/models/CreateHttpApiRequest.js.map +1 -1
  12. package/dist/models/CreateHttpApiRouteRequest.d.ts +8 -8
  13. package/dist/models/CreatePluginAttachmentRequest.d.ts +2 -2
  14. package/dist/models/CreatePolicyAttachmentRequest.d.ts +2 -2
  15. package/dist/models/CreatePolicyAttachmentResponseBody.d.ts +1 -1
  16. package/dist/models/CreatePolicyRequest.d.ts +21 -21
  17. package/dist/models/DeleteGatewayQuotaRuleResponseBody.d.ts +1 -1
  18. package/dist/models/DeployHttpApiRequest.d.ts +11 -11
  19. package/dist/models/GetDashboardRequest.d.ts +6 -6
  20. package/dist/models/GetDashboardResponseBody.d.ts +1 -1
  21. package/dist/models/GetDashboardShrinkRequest.d.ts +6 -6
  22. package/dist/models/GetHttpApiOperationResponseBody.d.ts +1 -1
  23. package/dist/models/GetHttpApiRequest.d.ts +1 -1
  24. package/dist/models/HttpApiDeployConfig.d.ts +25 -9
  25. package/dist/models/HttpApiDeployConfig.js +7 -0
  26. package/dist/models/HttpApiDeployConfig.js.map +1 -1
  27. package/dist/models/ImportHttpApiRequest.d.ts +14 -9
  28. package/dist/models/ImportHttpApiRequest.js.map +1 -1
  29. package/dist/models/ImportHttpApiResponseBody.d.ts +12 -8
  30. package/dist/models/ImportHttpApiResponseBody.js.map +1 -1
  31. package/dist/models/ListConsumerAuthorizationRulesRequest.d.ts +1 -1
  32. package/dist/models/ListConsumerAuthorizationRulesResponseBody.d.ts +2 -4
  33. package/dist/models/ListConsumerAuthorizationRulesResponseBody.js.map +1 -1
  34. package/dist/models/ListHttpApiOperationsRequest.d.ts +10 -10
  35. package/dist/models/ListHttpApiOperationsResponseBody.d.ts +3 -3
  36. package/dist/models/ListPluginAttachmentsRequest.d.ts +4 -4
  37. package/dist/models/ListPluginAttachmentsResponseBody.d.ts +7 -7
  38. package/dist/models/UpdatePluginAttachmentRequest.d.ts +2 -2
  39. package/package.json +1 -1
  40. package/src/client.ts +34 -24
  41. package/src/models/AddGatewayQuotaRuleRequest.ts +16 -16
  42. package/src/models/AddGatewayQuotaRuleResponseBody.ts +6 -11
  43. package/src/models/CreateConsumerRequest.ts +20 -4
  44. package/src/models/CreateHttpApiRequest.ts +28 -14
  45. package/src/models/CreateHttpApiRouteRequest.ts +8 -8
  46. package/src/models/CreatePluginAttachmentRequest.ts +2 -2
  47. package/src/models/CreatePolicyAttachmentRequest.ts +2 -2
  48. package/src/models/CreatePolicyAttachmentResponseBody.ts +1 -1
  49. package/src/models/CreatePolicyRequest.ts +21 -21
  50. package/src/models/DeleteGatewayQuotaRuleResponseBody.ts +1 -1
  51. package/src/models/DeployHttpApiRequest.ts +11 -11
  52. package/src/models/GetDashboardRequest.ts +6 -6
  53. package/src/models/GetDashboardResponseBody.ts +1 -1
  54. package/src/models/GetDashboardShrinkRequest.ts +6 -6
  55. package/src/models/GetHttpApiOperationResponseBody.ts +1 -1
  56. package/src/models/GetHttpApiRequest.ts +1 -1
  57. package/src/models/HttpApiDeployConfig.ts +32 -9
  58. package/src/models/ImportHttpApiRequest.ts +14 -9
  59. package/src/models/ImportHttpApiResponseBody.ts +12 -8
  60. package/src/models/ListConsumerAuthorizationRulesRequest.ts +1 -1
  61. package/src/models/ListConsumerAuthorizationRulesResponseBody.ts +2 -4
  62. package/src/models/ListHttpApiOperationsRequest.ts +10 -10
  63. package/src/models/ListHttpApiOperationsResponseBody.ts +3 -3
  64. package/src/models/ListPluginAttachmentsRequest.ts +4 -4
  65. package/src/models/ListPluginAttachmentsResponseBody.ts +7 -7
  66. package/src/models/UpdatePluginAttachmentRequest.ts +2 -2
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class ListHttpApiOperationsRequest extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * The consumer authorization rule ID used to filter the operation list. The response includes only operations that are authorized by the specified rule.
5
+ * Filters the API operation list by a specific consumer authorization rule ID. Only authorized API operations are included in the response.
6
6
  *
7
7
  * @example
8
8
  * cas-xxx
@@ -10,7 +10,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
10
10
  consumerAuthorizationRuleId?: string;
11
11
  /**
12
12
  * @remarks
13
- * The authentication enablement filter.
13
+ * The authentication enable filter.
14
14
  *
15
15
  * @example
16
16
  * true
@@ -34,7 +34,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
34
34
  gatewayId?: string;
35
35
  /**
36
36
  * @remarks
37
- * Lists operations by HTTP method.
37
+ * Filters API operations by HTTP method.
38
38
  *
39
39
  * @example
40
40
  * GET
@@ -42,7 +42,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
42
42
  method?: string;
43
43
  /**
44
44
  * @remarks
45
- * Searches for operations by exact name match.
45
+ * Filters API operations by exact name match.
46
46
  *
47
47
  * @example
48
48
  * getUserInfo
@@ -50,7 +50,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
50
50
  name?: string;
51
51
  /**
52
52
  * @remarks
53
- * Searches for operations by name prefix.
53
+ * Filters API operations by name prefix.
54
54
  *
55
55
  * @example
56
56
  * GetUser
@@ -58,7 +58,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
58
58
  nameLike?: string;
59
59
  /**
60
60
  * @remarks
61
- * The page number, starting from 1. Default value: 1.
61
+ * The page number. Starts from 1. Default value: 1.
62
62
  *
63
63
  * @example
64
64
  * 1
@@ -74,7 +74,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
74
74
  pageSize?: number;
75
75
  /**
76
76
  * @remarks
77
- * Searches for operations by path prefix match.
77
+ * Filters API operations by path prefix match.
78
78
  *
79
79
  * @example
80
80
  * /v1
@@ -82,7 +82,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
82
82
  pathLike?: string;
83
83
  /**
84
84
  * @remarks
85
- * The environment ID. When specified together with withConsumerInfoById, the response includes the authorization rule list of the specified consumer in the specified environment for each operation.
85
+ * Includes the authorization rule list for the specified consumer in the specified environment ID in each API operation\\"s information in the response. You must also specify the withConsumerInfoById field.
86
86
  *
87
87
  * @example
88
88
  * env-xxx
@@ -90,7 +90,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
90
90
  withConsumerInEnvironmentId?: string;
91
91
  /**
92
92
  * @remarks
93
- * The consumer ID. When specified together with withConsumerInEnvironmentId, the response includes the authorization rule list of the specified consumer in the specified environment for each operation.
93
+ * Includes the authorization rule list for the specified consumer in the specified environment ID in each API operation\\"s information in the response. You must also specify the withConsumerInEnvironmentId field.
94
94
  *
95
95
  * @example
96
96
  * cs-xxx
@@ -98,7 +98,7 @@ export declare class ListHttpApiOperationsRequest extends $dara.Model {
98
98
  withConsumerInfoById?: string;
99
99
  /**
100
100
  * @remarks
101
- * The plugin ID used to retrieve plugin deployment information.
101
+ * The plug-in ID. Retrieves plug-in publish information based on this plug-in ID.
102
102
  *
103
103
  * @example
104
104
  * pl-xxx
@@ -3,7 +3,7 @@ import { HttpApiOperationInfo } from "./HttpApiOperationInfo";
3
3
  export declare class ListHttpApiOperationsResponseBodyData extends $dara.Model {
4
4
  /**
5
5
  * @remarks
6
- * The list of operations.
6
+ * The API operation list.
7
7
  */
8
8
  items?: HttpApiOperationInfo[];
9
9
  /**
@@ -24,7 +24,7 @@ export declare class ListHttpApiOperationsResponseBodyData extends $dara.Model {
24
24
  pageSize?: number;
25
25
  /**
26
26
  * @remarks
27
- * The total number of entries.
27
+ * The total count.
28
28
  *
29
29
  * @example
30
30
  * 10
@@ -52,7 +52,7 @@ export declare class ListHttpApiOperationsResponseBody extends $dara.Model {
52
52
  code?: string;
53
53
  /**
54
54
  * @remarks
55
- * The list of operations.
55
+ * The API operation list.
56
56
  */
57
57
  data?: ListHttpApiOperationsResponseBodyData;
58
58
  /**
@@ -10,7 +10,7 @@ export declare class ListPluginAttachmentsRequest extends $dara.Model {
10
10
  attachResourceId?: string;
11
11
  /**
12
12
  * @remarks
13
- * The plugin mount point type. This parameter is not yet enabled.
13
+ * The plug-in mount point type. Not enabled yet.
14
14
  *
15
15
  * @example
16
16
  * GatewayRoute
@@ -18,7 +18,7 @@ export declare class ListPluginAttachmentsRequest extends $dara.Model {
18
18
  attachResourceType?: string;
19
19
  /**
20
20
  * @remarks
21
- * The mount point types. Separate multiple types with commas.
21
+ * The mount point types. Separate multiple values with commas.
22
22
  *
23
23
  * @example
24
24
  * GatewayRoute
@@ -58,7 +58,7 @@ export declare class ListPluginAttachmentsRequest extends $dara.Model {
58
58
  pageSize?: number;
59
59
  /**
60
60
  * @remarks
61
- * The plugin ID.
61
+ * The plug-in ID.
62
62
  *
63
63
  * @example
64
64
  * pl-ct8181um1hkiqns9f6e0
@@ -66,7 +66,7 @@ export declare class ListPluginAttachmentsRequest extends $dara.Model {
66
66
  pluginId?: string;
67
67
  /**
68
68
  * @remarks
69
- * Specifies whether to return parent resource mounts.
69
+ * Specifies whether to return the parent resource mount.
70
70
  *
71
71
  * @example
72
72
  * false
@@ -6,7 +6,7 @@ import { ResourceInfo } from "./ResourceInfo";
6
6
  export declare class ListPluginAttachmentsResponseBodyDataItems extends $dara.Model {
7
7
  /**
8
8
  * @remarks
9
- * The plugin mount resource type. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, and Operation.
9
+ * The plug-in mount resource type. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, Operation.
10
10
  *
11
11
  * @example
12
12
  * GatewayRoute
@@ -14,7 +14,7 @@ export declare class ListPluginAttachmentsResponseBodyDataItems extends $dara.Mo
14
14
  attachResourceType?: string;
15
15
  /**
16
16
  * @remarks
17
- * Indicates whether the plugin mount is enabled.
17
+ * Specifies whether the plug-in is enabled.
18
18
  *
19
19
  * @example
20
20
  * true
@@ -32,7 +32,7 @@ export declare class ListPluginAttachmentsResponseBodyDataItems extends $dara.Mo
32
32
  parentResourceInfo?: ParentResourceInfo;
33
33
  /**
34
34
  * @remarks
35
- * The plugin mount ID.
35
+ * The plug-in mount ID.
36
36
  *
37
37
  * @example
38
38
  * pa-d0j9t5em1hkncrlo51mg
@@ -40,12 +40,12 @@ export declare class ListPluginAttachmentsResponseBodyDataItems extends $dara.Mo
40
40
  pluginAttachmentId?: string;
41
41
  /**
42
42
  * @remarks
43
- * The plugin type information.
43
+ * The plug-in type information.
44
44
  */
45
45
  pluginClassInfo?: PluginClassInfo;
46
46
  /**
47
47
  * @remarks
48
- * The Base64-encoded content of the original plugin configuration.
48
+ * The Base64-encoded content of the original plug-in configuration.
49
49
  *
50
50
  * @example
51
51
  * bGltaXRfYnlfaGVhZGVyOiB4LWFwaS1rZXkKbGltaXRfa2V5czoKLSBrZXk6IGV4YW1wbGUta2V5LWEKICBxdWVyeV9wZXJfc2Vjb25kOiAxMAotIGtleTogZXhhbXBsZS1rZXktYgogIHF1ZXJ5X3Blcl9zZWNvbmQ6IDEK
@@ -53,7 +53,7 @@ export declare class ListPluginAttachmentsResponseBodyDataItems extends $dara.Mo
53
53
  pluginConfig?: string;
54
54
  /**
55
55
  * @remarks
56
- * The plugin ID.
56
+ * The plug-in ID.
57
57
  *
58
58
  * @example
59
59
  * pl-cvu6r4um1hko3b3ti0a0
@@ -99,7 +99,7 @@ export declare class ListPluginAttachmentsResponseBodyData extends $dara.Model {
99
99
  pageSize?: number;
100
100
  /**
101
101
  * @remarks
102
- * The total count.
102
+ * The total number of entries.
103
103
  *
104
104
  * @example
105
105
  * 10
@@ -7,7 +7,7 @@ export declare class UpdatePluginAttachmentRequest extends $dara.Model {
7
7
  attachResourceIds?: string[];
8
8
  /**
9
9
  * @remarks
10
- * Specifies whether to enable the plugin.
10
+ * Specifies whether to enable the plugin mount.
11
11
  *
12
12
  * @example
13
13
  * false
@@ -15,7 +15,7 @@ export declare class UpdatePluginAttachmentRequest extends $dara.Model {
15
15
  enable?: boolean;
16
16
  /**
17
17
  * @remarks
18
- * The Base64-encoded content of the original plugin configuration.
18
+ * The Base64-encoded content of the raw plugin configuration.
19
19
  *
20
20
  * @example
21
21
  * cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alicloud/apig20240327",
3
- "version": "11.3.2",
3
+ "version": "11.3.3",
4
4
  "description": "",
5
5
  "main": "dist/client.js",
6
6
  "scripts": {
package/src/client.ts CHANGED
@@ -38,8 +38,8 @@ export default class Client extends OpenApi {
38
38
  * > Recommended call sequence:
39
39
  * > - Step 1: Perform a dry run to check for rule conflicts.
40
40
  * > - - Set dryRun to true.
41
- * > - - The response returns a conflict preview that contains the conflictHash value.
42
- * > - Step 2: Submit the request after confirmation.
41
+ * > - - The response returns a conflict preview that contains conflictHash.
42
+ * > - Step 2: Submit the rule after confirmation.
43
43
  * > - - No conflicts: Set dryRun to false and overwrite to false.
44
44
  * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
45
45
  *
@@ -130,8 +130,8 @@ export default class Client extends OpenApi {
130
130
  * > Recommended call sequence:
131
131
  * > - Step 1: Perform a dry run to check for rule conflicts.
132
132
  * > - - Set dryRun to true.
133
- * > - - The response returns a conflict preview that contains the conflictHash value.
134
- * > - Step 2: Submit the request after confirmation.
133
+ * > - - The response returns a conflict preview that contains conflictHash.
134
+ * > - Step 2: Submit the rule after confirmation.
135
135
  * > - - No conflicts: Set dryRun to false and overwrite to false.
136
136
  * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
137
137
  *
@@ -807,6 +807,15 @@ export default class Client extends OpenApi {
807
807
  */
808
808
  async createConsumerWithOptions(request: $_model.CreateConsumerRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateConsumerResponse> {
809
809
  request.validate();
810
+ let query : {[key: string ]: any} = { };
811
+ if (!$dara.isNull(request.clientToken)) {
812
+ query["clientToken"] = request.clientToken;
813
+ }
814
+
815
+ if (!$dara.isNull(request.dryRun)) {
816
+ query["dryRun"] = request.dryRun;
817
+ }
818
+
810
819
  let body : {[key: string ]: any} = { };
811
820
  if (!$dara.isNull(request.akSkIdentityConfigs)) {
812
821
  body["akSkIdentityConfigs"] = request.akSkIdentityConfigs;
@@ -838,6 +847,7 @@ export default class Client extends OpenApi {
838
847
 
839
848
  let req = new $OpenApiUtil.OpenApiRequest({
840
849
  headers: headers,
850
+ query: OpenApiUtil.query(query),
841
851
  body: OpenApiUtil.parseToMap(body),
842
852
  });
843
853
  let params = new $OpenApiUtil.Params({
@@ -1425,7 +1435,7 @@ export default class Client extends OpenApi {
1425
1435
  }
1426
1436
 
1427
1437
  /**
1428
- * Creates operations for an HTTP API.
1438
+ * Creates an operation for an HTTP API.
1429
1439
  *
1430
1440
  * @param request - CreateHttpApiOperationRequest
1431
1441
  * @param headers - map
@@ -1458,7 +1468,7 @@ export default class Client extends OpenApi {
1458
1468
  }
1459
1469
 
1460
1470
  /**
1461
- * Creates operations for an HTTP API.
1471
+ * Creates an operation for an HTTP API.
1462
1472
  *
1463
1473
  * @param request - CreateHttpApiOperationRequest
1464
1474
  * @returns CreateHttpApiOperationResponse
@@ -2032,7 +2042,7 @@ export default class Client extends OpenApi {
2032
2042
  }
2033
2043
 
2034
2044
  /**
2035
- * Creates a policy attachment to a resource.
2045
+ * Creates a policy resource mount.
2036
2046
  *
2037
2047
  * @param request - CreatePolicyAttachmentRequest
2038
2048
  * @param headers - map
@@ -2081,7 +2091,7 @@ export default class Client extends OpenApi {
2081
2091
  }
2082
2092
 
2083
2093
  /**
2084
- * Creates a policy attachment to a resource.
2094
+ * Creates a policy resource mount.
2085
2095
  *
2086
2096
  * @param request - CreatePolicyAttachmentRequest
2087
2097
  * @returns CreatePolicyAttachmentResponse
@@ -2673,10 +2683,10 @@ export default class Client extends OpenApi {
2673
2683
  }
2674
2684
 
2675
2685
  /**
2676
- * Deletes a quota throttling rule from a gateway.
2686
+ * Deletes a quota throttling rule for a gateway.
2677
2687
  *
2678
2688
  * @remarks
2679
- * This operation deletes a consumer-based or consumer group-based quota rule from an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
2689
+ * Deletes a quota rule based on an API consumer or consumer group for an AI gateway. This operation only takes effect on AI gateways with a version later than 2.1.19.
2680
2690
  *
2681
2691
  * @param request - DeleteGatewayQuotaRuleRequest
2682
2692
  * @param headers - map
@@ -2703,10 +2713,10 @@ export default class Client extends OpenApi {
2703
2713
  }
2704
2714
 
2705
2715
  /**
2706
- * Deletes a quota throttling rule from a gateway.
2716
+ * Deletes a quota throttling rule for a gateway.
2707
2717
  *
2708
2718
  * @remarks
2709
- * This operation deletes a consumer-based or consumer group-based quota rule from an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
2719
+ * Deletes a quota rule based on an API consumer or consumer group for an AI gateway. This operation only takes effect on AI gateways with a version later than 2.1.19.
2710
2720
  *
2711
2721
  * @param request - DeleteGatewayQuotaRuleRequest
2712
2722
  * @returns DeleteGatewayQuotaRuleResponse
@@ -4134,7 +4144,7 @@ export default class Client extends OpenApi {
4134
4144
  }
4135
4145
 
4136
4146
  /**
4137
- * Retrieves HTTP API information.
4147
+ * Retrieves the information of an HTTP API.
4138
4148
  *
4139
4149
  * @param request - GetHttpApiRequest
4140
4150
  * @param headers - map
@@ -4167,7 +4177,7 @@ export default class Client extends OpenApi {
4167
4177
  }
4168
4178
 
4169
4179
  /**
4170
- * Retrieves HTTP API information.
4180
+ * Retrieves the information of an HTTP API.
4171
4181
  *
4172
4182
  * @param request - GetHttpApiRequest
4173
4183
  * @returns GetHttpApiResponse
@@ -4179,7 +4189,7 @@ export default class Client extends OpenApi {
4179
4189
  }
4180
4190
 
4181
4191
  /**
4182
- * Retrieves operation information.
4192
+ * Retrieves the API operation information.
4183
4193
  *
4184
4194
  * @param headers - map
4185
4195
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4204,7 +4214,7 @@ export default class Client extends OpenApi {
4204
4214
  }
4205
4215
 
4206
4216
  /**
4207
- * Retrieves operation information.
4217
+ * Retrieves the API operation information.
4208
4218
  * @returns GetHttpApiOperationResponse
4209
4219
  */
4210
4220
  async getHttpApiOperation(httpApiId: string, operationId: string): Promise<$_model.GetHttpApiOperationResponse> {
@@ -4838,7 +4848,7 @@ export default class Client extends OpenApi {
4838
4848
  }
4839
4849
 
4840
4850
  /**
4841
- * Imports an HTTP API. You can import an OpenAPI 2.0 or OpenAPI 3.0.x definition file as a REST API.
4851
+ * Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
4842
4852
  *
4843
4853
  * @param request - ImportHttpApiRequest
4844
4854
  * @param headers - map
@@ -4923,7 +4933,7 @@ export default class Client extends OpenApi {
4923
4933
  }
4924
4934
 
4925
4935
  /**
4926
- * Imports an HTTP API. You can import an OpenAPI 2.0 or OpenAPI 3.0.x definition file as a REST API.
4936
+ * Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
4927
4937
  *
4928
4938
  * @param request - ImportHttpApiRequest
4929
4939
  * @returns ImportHttpApiResponse
@@ -5295,7 +5305,7 @@ export default class Client extends OpenApi {
5295
5305
  }
5296
5306
 
5297
5307
  /**
5298
- * Retrieves the list of consumer authorization rules.
5308
+ * Retrieves a list of consumer authorization rules.
5299
5309
  *
5300
5310
  * @param request - ListConsumerAuthorizationRulesRequest
5301
5311
  * @param headers - map
@@ -5336,7 +5346,7 @@ export default class Client extends OpenApi {
5336
5346
  }
5337
5347
 
5338
5348
  /**
5339
- * Retrieves the list of consumer authorization rules.
5349
+ * Retrieves a list of consumer authorization rules.
5340
5350
  *
5341
5351
  * @param request - ListConsumerAuthorizationRulesRequest
5342
5352
  * @returns ListConsumerAuthorizationRulesResponse
@@ -6909,7 +6919,7 @@ export default class Client extends OpenApi {
6909
6919
  }
6910
6920
 
6911
6921
  /**
6912
- * Retrieves the list of plugin mounts.
6922
+ * Retrieves the plug-in mount list.
6913
6923
  *
6914
6924
  * @param request - ListPluginAttachmentsRequest
6915
6925
  * @param headers - map
@@ -6974,7 +6984,7 @@ export default class Client extends OpenApi {
6974
6984
  }
6975
6985
 
6976
6986
  /**
6977
- * Retrieves the list of plugin mounts.
6987
+ * Retrieves the plug-in mount list.
6978
6988
  *
6979
6989
  * @param request - ListPluginAttachmentsRequest
6980
6990
  * @returns ListPluginAttachmentsResponse
@@ -8849,7 +8859,7 @@ export default class Client extends OpenApi {
8849
8859
  * Updates a consumer authorization rule.
8850
8860
  *
8851
8861
  * @remarks
8852
- * 该 API 已被 UpdateAuthorizationRule 替代,新路径为 /v1/authorization-rules/{consumerAuthorizationRuleId}
8862
+ * This API has been replaced by UpdateAuthorizationRule. The new operation path is /v1/authorization-rules/{consumerAuthorizationRuleId}. When calling the new operation, you only need to provide consumerAuthorizationRuleId in the path and the resources array in the request body. The consumerId parameter is no longer required.
8853
8863
  *
8854
8864
  * @param request - UpdateConsumerAuthorizationRuleRequest
8855
8865
  * @param headers - map
@@ -8893,7 +8903,7 @@ export default class Client extends OpenApi {
8893
8903
  * Updates a consumer authorization rule.
8894
8904
  *
8895
8905
  * @remarks
8896
- * 该 API 已被 UpdateAuthorizationRule 替代,新路径为 /v1/authorization-rules/{consumerAuthorizationRuleId}
8906
+ * This API has been replaced by UpdateAuthorizationRule. The new operation path is /v1/authorization-rules/{consumerAuthorizationRuleId}. When calling the new operation, you only need to provide consumerAuthorizationRuleId in the path and the resources array in the request body. The consumerId parameter is no longer required.
8897
8907
  *
8898
8908
  * @param request - UpdateConsumerAuthorizationRuleRequest
8899
8909
  * @returns UpdateConsumerAuthorizationRuleResponse
@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class AddGatewayQuotaRuleRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The conflict snapshot hash used to prevent concurrent dirty overwrites during confirmation. Obtain this value from the response of a previous dry run (dryRun=true).
8
+ * The conflict snapshot hash, used to prevent concurrent dirty overwrites during confirmation. Retrieve this value from the response of a previous dry run (dryRun=true).
9
9
  *
10
10
  * 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.
11
11
  *
12
- * When dryRun is set to false and overwrite is set to true, if this parameter is not provided or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. In this case, perform a new dry run to confirm the latest conflicts.
12
+ * When dryRun is set to false and overwrite is set to true, if this parameter is not provided or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. Perform a new dry run to confirm the updated conflicts.
13
13
  *
14
14
  * @example
15
15
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
@@ -17,7 +17,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
17
17
  conflictHash?: string;
18
18
  /**
19
19
  * @remarks
20
- * The list of API consumer group IDs to bind to the rule. This parameter is used when subjectType is set to consumer_group and cannot be specified together with consumerIds.
20
+ * The list of consumer group IDs to bind to the rule. Specify this parameter when subjectType is set to consumer_group. This parameter cannot be specified together with consumerIds.
21
21
  *
22
22
  * @example
23
23
  * group1,group2
@@ -25,7 +25,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
25
25
  consumerGroupIds?: string[];
26
26
  /**
27
27
  * @remarks
28
- * The list of API consumer IDs to bind to the rule. A maximum of 1,000 consumers can be specified in a single request.
28
+ * The list of consumer IDs to bind to the rule. A maximum of 1,000 consumers can be specified in a single request.
29
29
  *
30
30
  * @example
31
31
  * 1001,1002,1003
@@ -33,7 +33,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
33
33
  consumerIds?: string[];
34
34
  /**
35
35
  * @remarks
36
- * 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 consumer subjects. For example, a consumer subject that already has a calendar-day quota rule cannot have another calendar-day quota rule added.
36
+ * Specifies whether to perform only a dry run without applying the configuration. A dry run checks whether conflicting rules exist on the bound consumer subjects. For example, a consumer subject that already has a calendar-day quota cannot have another calendar-day quota rule added.
37
37
  *
38
38
  * @example
39
39
  * false
@@ -41,7 +41,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
41
41
  dryRun?: boolean;
42
42
  /**
43
43
  * @remarks
44
- * Specifies whether to allow overwriting when conflicts exist. If overwriting is allowed, the conflicting subjects (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
44
+ * Specifies whether to allow overwriting on conflict. If overwriting is allowed, the conflicting subjects (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
45
45
  *
46
46
  * @example
47
47
  * false
@@ -49,7 +49,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
49
49
  overwrite?: boolean;
50
50
  /**
51
51
  * @remarks
52
- * The period multiplier, which specifies the number of periods after which the quota resets. This parameter is required for custom (epoch) period rules. Minimum value: 1. Maximum value: 60.
52
+ * The period multiplier, which specifies the number of periods after which the quota resets. This parameter is required for custom period rules. Minimum value: 1. Maximum value: 60.
53
53
  *
54
54
  * @example
55
55
  * 10
@@ -57,7 +57,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
57
57
  periodMultiplier?: number;
58
58
  /**
59
59
  * @remarks
60
- * The period type. For calendar periods, the quota can be calculated by day, week, or month. Valid values: day, week, and month. For custom (epoch) periods, only day is supported.
60
+ * The period type. For calendar periods, the value can be day, week, or month. For custom periods, only day is supported.
61
61
  *
62
62
  * This parameter is required.
63
63
  *
@@ -97,11 +97,10 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
97
97
  ruleName?: string;
98
98
  /**
99
99
  * @remarks
100
- * The type of the rule subject. Valid values:
101
- * - consumer: API consumer.
102
- * - consumer_group: API consumer group.
100
+ * The subject type of the rule. Valid values:
103
101
  *
104
- * Default value: consumer.
102
+ * - consumer: API consumer. This is the default value.
103
+ * - consumer_group: API consumer group.
105
104
  *
106
105
  * @example
107
106
  * consumer_group
@@ -109,7 +108,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
109
108
  subjectType?: string;
110
109
  /**
111
110
  * @remarks
112
- * The time zone for calendar periods, in UTC+x format.
111
+ * The time zone for the calendar period, in UTC+x format.
113
112
  *
114
113
  * @example
115
114
  * UTC+8
@@ -117,9 +116,10 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
117
116
  timezone?: string;
118
117
  /**
119
118
  * @remarks
120
- * The reset period alignment type. Valid values:
121
- * - calendar: The quota resets at the beginning of a calendar day, week, or month.
122
- * - epoch: The quota resets based on a custom period that starts when the rule takes effect.
119
+ * The reset period type. Valid values:
120
+ *
121
+ * - calendar: calendar period. The period starts from the beginning of a calendar day, week, or month.
122
+ * - epoch: custom period. The period starts from the time the rule is applied.
123
123
  *
124
124
  * @example
125
125
  * calendar
@@ -5,10 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The period type of the existing conflicting rule on the consumer subject. Valid values:
9
- * - day: The existing conflicting rule has a daily period.
10
- * - week: The existing conflicting rule has a weekly period.
11
- * - month: The existing conflicting rule has a monthly period.
8
+ * The period type of the existing conflicting rule on the consumer subject. A value of day, week, or month indicates that the period of the existing conflicting rule is day, week, or month respectively.
12
9
  *
13
10
  * @example
14
11
  * week
@@ -16,9 +13,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
16
13
  conflictPeriodType?: string;
17
14
  /**
18
15
  * @remarks
19
- * The type of the existing conflicting rule on the consumer subject. Valid values:
20
- * - calendar: The existing conflicting rule uses a calendar period.
21
- * - epoch: The existing conflicting rule uses a custom period.
16
+ * The type of the existing conflicting rule on the consumer subject. A value of calendar indicates that the existing conflicting rule uses a calendar period. A value of epoch indicates that the existing conflicting rule uses a custom period.
22
17
  *
23
18
  * @example
24
19
  * calendar
@@ -26,7 +21,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
26
21
  conflictType?: string;
27
22
  /**
28
23
  * @remarks
29
- * The conflicting consumer ID. You can use subjectId instead.
24
+ * The conflicting consumer ID. Use subjectId instead.
30
25
  *
31
26
  * @example
32
27
  * cs-xxxxxx
@@ -34,7 +29,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
34
29
  consumerId?: string;
35
30
  /**
36
31
  * @remarks
37
- * The conflicting consumer name. You can use subjectName instead.
32
+ * The conflicting consumer name. Use subjectName instead.
38
33
  *
39
34
  * @example
40
35
  * consumer-a
@@ -100,7 +95,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
100
95
  export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
101
96
  /**
102
97
  * @remarks
103
- * The conflict snapshot hash.
98
+ * The conflict hash.
104
99
  *
105
100
  * @example
106
101
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
@@ -226,7 +221,7 @@ export class AddGatewayQuotaRuleResponseBody extends $dara.Model {
226
221
  data?: AddGatewayQuotaRuleResponseBodyData;
227
222
  /**
228
223
  * @remarks
229
- * The response message.
224
+ * The message content.
230
225
  *
231
226
  * @example
232
227
  * success
@@ -13,7 +13,7 @@ export class CreateConsumerRequest extends $dara.Model {
13
13
  akSkIdentityConfigs?: AkSkIdentityConfig[];
14
14
  /**
15
15
  * @remarks
16
- * The API key authentication identity configuration.
16
+ * The identity configuration for API key authentication.
17
17
  */
18
18
  apikeyIdentityConfig?: ApiKeyIdentityConfig;
19
19
  /**
@@ -35,9 +35,8 @@ export class CreateConsumerRequest extends $dara.Model {
35
35
  /**
36
36
  * @remarks
37
37
  * The gateway type. Valid values:
38
- *
39
- * - API: a consumer of a cloud-native API gateway.
40
- * - AI: a consumer of an AI gateway.
38
+ * - API: a consumer for Cloud-Native API Gateway.
39
+ * - AI: a consumer for AI Gateway.
41
40
  *
42
41
  * @example
43
42
  * API
@@ -56,6 +55,19 @@ export class CreateConsumerRequest extends $dara.Model {
56
55
  * test
57
56
  */
58
57
  name?: string;
58
+ /**
59
+ * @remarks
60
+ * The idempotency token generated by the caller as a globally unique value (UUID recommended), with a maximum length of 64 characters. Within approximately 24 hours after the first successful request, a duplicate request that carries the same ClientToken and identical request parameters directly returns the consumerId from the first creation without creating a new consumer. A request that carries the same ClientToken but different request parameters returns IdempotentParameterMismatch. If the first request is still being processed, IdempotentProcessing is returned. If this parameter is not specified, idempotency control is disabled and the behavior is consistent with earlier versions.
61
+ *
62
+ * @example
63
+ * 5f7a2c1e-9b3d-4e8f-a1c6-0d2b8e4f7a13
64
+ */
65
+ clientToken?: string;
66
+ /**
67
+ * @remarks
68
+ * Specifies whether to perform only a dry run. If this parameter is set to true, the system performs the same parameter, permission, IAM, resource policy, resource existence, and business rule validations as a real creation request, but does not create the consumer, write to the database, create or delete SecretRef, or produce other side effects such as audit logs. If this parameter is not specified or is set to false, the behavior is consistent with earlier versions.
69
+ */
70
+ dryRun?: boolean;
59
71
  static names(): { [key: string]: string } {
60
72
  return {
61
73
  akSkIdentityConfigs: 'akSkIdentityConfigs',
@@ -65,6 +77,8 @@ export class CreateConsumerRequest extends $dara.Model {
65
77
  gatewayType: 'gatewayType',
66
78
  jwtIdentityConfig: 'jwtIdentityConfig',
67
79
  name: 'name',
80
+ clientToken: 'clientToken',
81
+ dryRun: 'dryRun',
68
82
  };
69
83
  }
70
84
 
@@ -77,6 +91,8 @@ export class CreateConsumerRequest extends $dara.Model {
77
91
  gatewayType: 'string',
78
92
  jwtIdentityConfig: JwtIdentityConfig,
79
93
  name: 'string',
94
+ clientToken: 'string',
95
+ dryRun: 'boolean',
80
96
  };
81
97
  }
82
98