@alicloud/apig20240327 11.3.2 → 11.3.4
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 +20 -20
- package/dist/client.js +33 -20
- package/dist/client.js.map +1 -1
- package/dist/models/AddGatewayQuotaRuleRequest.d.ts +16 -16
- package/dist/models/AddGatewayQuotaRuleResponseBody.d.ts +6 -11
- package/dist/models/AddGatewayQuotaRuleResponseBody.js.map +1 -1
- package/dist/models/CreateConsumerRequest.d.ts +16 -4
- package/dist/models/CreateConsumerRequest.js +4 -0
- package/dist/models/CreateConsumerRequest.js.map +1 -1
- package/dist/models/CreateHttpApiRequest.d.ts +35 -13
- package/dist/models/CreateHttpApiRequest.js +2 -0
- package/dist/models/CreateHttpApiRequest.js.map +1 -1
- package/dist/models/CreateHttpApiRouteRequest.d.ts +10 -10
- package/dist/models/CreatePluginAttachmentRequest.d.ts +2 -2
- package/dist/models/CreatePolicyAttachmentRequest.d.ts +2 -2
- package/dist/models/CreatePolicyAttachmentResponseBody.d.ts +1 -1
- package/dist/models/CreatePolicyRequest.d.ts +21 -21
- package/dist/models/DeleteGatewayQuotaRuleResponseBody.d.ts +1 -1
- package/dist/models/DeployHttpApiRequest.d.ts +11 -11
- package/dist/models/GetConsumerAuthorizationRuleResponseBody.d.ts +2 -3
- package/dist/models/GetConsumerAuthorizationRuleResponseBody.js.map +1 -1
- package/dist/models/GetDashboardRequest.d.ts +3 -0
- package/dist/models/GetDashboardRequest.js.map +1 -1
- package/dist/models/GetDashboardResponseBody.d.ts +1 -1
- package/dist/models/GetDashboardShrinkRequest.d.ts +3 -0
- package/dist/models/GetDashboardShrinkRequest.js.map +1 -1
- package/dist/models/GetHttpApiRequest.d.ts +1 -1
- package/dist/models/HttpApiDeployConfig.d.ts +25 -9
- package/dist/models/HttpApiDeployConfig.js +7 -0
- package/dist/models/HttpApiDeployConfig.js.map +1 -1
- package/dist/models/ImportHttpApiRequest.d.ts +14 -9
- package/dist/models/ImportHttpApiRequest.js.map +1 -1
- package/dist/models/ImportHttpApiResponseBody.d.ts +12 -8
- package/dist/models/ImportHttpApiResponseBody.js.map +1 -1
- package/dist/models/ListConsumerAuthorizationRulesRequest.d.ts +1 -1
- package/dist/models/ListConsumerAuthorizationRulesResponseBody.d.ts +2 -4
- package/dist/models/ListConsumerAuthorizationRulesResponseBody.js.map +1 -1
- package/dist/models/ListHttpApiOperationsRequest.d.ts +10 -10
- package/dist/models/ListHttpApiOperationsResponseBody.d.ts +3 -3
- package/dist/models/ListHttpApisRequest.d.ts +9 -9
- package/dist/models/ListPluginAttachmentsRequest.d.ts +4 -4
- package/dist/models/ListPluginAttachmentsResponseBody.d.ts +7 -7
- package/dist/models/QueryConsumerAuthorizationRulesRequest.d.ts +6 -6
- package/dist/models/QueryConsumerAuthorizationRulesResponseBody.d.ts +8 -10
- package/dist/models/QueryConsumerAuthorizationRulesResponseBody.js.map +1 -1
- package/dist/models/UpdateHttpApiRequest.d.ts +5 -5
- package/dist/models/UpdatePluginAttachmentRequest.d.ts +2 -2
- package/package.json +1 -1
- package/src/client.ts +36 -20
- package/src/models/AddGatewayQuotaRuleRequest.ts +16 -16
- package/src/models/AddGatewayQuotaRuleResponseBody.ts +6 -11
- package/src/models/CreateConsumerRequest.ts +20 -4
- package/src/models/CreateHttpApiRequest.ts +37 -13
- package/src/models/CreateHttpApiRouteRequest.ts +10 -10
- package/src/models/CreatePluginAttachmentRequest.ts +2 -2
- package/src/models/CreatePolicyAttachmentRequest.ts +2 -2
- package/src/models/CreatePolicyAttachmentResponseBody.ts +1 -1
- package/src/models/CreatePolicyRequest.ts +21 -21
- package/src/models/DeleteGatewayQuotaRuleResponseBody.ts +1 -1
- package/src/models/DeployHttpApiRequest.ts +11 -11
- package/src/models/GetConsumerAuthorizationRuleResponseBody.ts +2 -3
- package/src/models/GetDashboardRequest.ts +3 -0
- package/src/models/GetDashboardResponseBody.ts +1 -1
- package/src/models/GetDashboardShrinkRequest.ts +3 -0
- package/src/models/GetHttpApiRequest.ts +1 -1
- package/src/models/HttpApiDeployConfig.ts +32 -9
- package/src/models/ImportHttpApiRequest.ts +14 -9
- package/src/models/ImportHttpApiResponseBody.ts +12 -8
- package/src/models/ListConsumerAuthorizationRulesRequest.ts +1 -1
- package/src/models/ListConsumerAuthorizationRulesResponseBody.ts +2 -4
- package/src/models/ListHttpApiOperationsRequest.ts +10 -10
- package/src/models/ListHttpApiOperationsResponseBody.ts +3 -3
- package/src/models/ListHttpApisRequest.ts +9 -9
- package/src/models/ListPluginAttachmentsRequest.ts +4 -4
- package/src/models/ListPluginAttachmentsResponseBody.ts +7 -7
- package/src/models/QueryConsumerAuthorizationRulesRequest.ts +6 -6
- package/src/models/QueryConsumerAuthorizationRulesResponseBody.ts +8 -10
- package/src/models/UpdateHttpApiRequest.ts +5 -5
- package/src/models/UpdatePluginAttachmentRequest.ts +2 -2
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
|
|
42
|
-
* > - Step 2: Submit the
|
|
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
|
|
134
|
-
* > - Step 2: Submit the
|
|
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({
|
|
@@ -1317,6 +1327,11 @@ export default class Client extends OpenApi {
|
|
|
1317
1327
|
*/
|
|
1318
1328
|
async createHttpApiWithOptions(request: $_model.CreateHttpApiRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateHttpApiResponse> {
|
|
1319
1329
|
request.validate();
|
|
1330
|
+
let query : {[key: string ]: any} = { };
|
|
1331
|
+
if (!$dara.isNull(request.clientToken)) {
|
|
1332
|
+
query["clientToken"] = request.clientToken;
|
|
1333
|
+
}
|
|
1334
|
+
|
|
1320
1335
|
let body : {[key: string ]: any} = { };
|
|
1321
1336
|
if (!$dara.isNull(request.agentProtocols)) {
|
|
1322
1337
|
body["agentProtocols"] = request.agentProtocols;
|
|
@@ -1396,6 +1411,7 @@ export default class Client extends OpenApi {
|
|
|
1396
1411
|
|
|
1397
1412
|
let req = new $OpenApiUtil.OpenApiRequest({
|
|
1398
1413
|
headers: headers,
|
|
1414
|
+
query: OpenApiUtil.query(query),
|
|
1399
1415
|
body: OpenApiUtil.parseToMap(body),
|
|
1400
1416
|
});
|
|
1401
1417
|
let params = new $OpenApiUtil.Params({
|
|
@@ -2032,7 +2048,7 @@ export default class Client extends OpenApi {
|
|
|
2032
2048
|
}
|
|
2033
2049
|
|
|
2034
2050
|
/**
|
|
2035
|
-
* Creates a policy
|
|
2051
|
+
* Creates a policy resource mount.
|
|
2036
2052
|
*
|
|
2037
2053
|
* @param request - CreatePolicyAttachmentRequest
|
|
2038
2054
|
* @param headers - map
|
|
@@ -2081,7 +2097,7 @@ export default class Client extends OpenApi {
|
|
|
2081
2097
|
}
|
|
2082
2098
|
|
|
2083
2099
|
/**
|
|
2084
|
-
* Creates a policy
|
|
2100
|
+
* Creates a policy resource mount.
|
|
2085
2101
|
*
|
|
2086
2102
|
* @param request - CreatePolicyAttachmentRequest
|
|
2087
2103
|
* @returns CreatePolicyAttachmentResponse
|
|
@@ -2673,10 +2689,10 @@ export default class Client extends OpenApi {
|
|
|
2673
2689
|
}
|
|
2674
2690
|
|
|
2675
2691
|
/**
|
|
2676
|
-
* Deletes a quota throttling rule
|
|
2692
|
+
* Deletes a quota throttling rule for a gateway.
|
|
2677
2693
|
*
|
|
2678
2694
|
* @remarks
|
|
2679
|
-
*
|
|
2695
|
+
* Deletes a quota rule based on an API consumer or consumer group from an AI gateway. This operation only takes effect on AI gateways with a version later than 2.1.19.
|
|
2680
2696
|
*
|
|
2681
2697
|
* @param request - DeleteGatewayQuotaRuleRequest
|
|
2682
2698
|
* @param headers - map
|
|
@@ -2703,10 +2719,10 @@ export default class Client extends OpenApi {
|
|
|
2703
2719
|
}
|
|
2704
2720
|
|
|
2705
2721
|
/**
|
|
2706
|
-
* Deletes a quota throttling rule
|
|
2722
|
+
* Deletes a quota throttling rule for a gateway.
|
|
2707
2723
|
*
|
|
2708
2724
|
* @remarks
|
|
2709
|
-
*
|
|
2725
|
+
* Deletes a quota rule based on an API consumer or consumer group from an AI gateway. This operation only takes effect on AI gateways with a version later than 2.1.19.
|
|
2710
2726
|
*
|
|
2711
2727
|
* @param request - DeleteGatewayQuotaRuleRequest
|
|
2712
2728
|
* @returns DeleteGatewayQuotaRuleResponse
|
|
@@ -4134,7 +4150,7 @@ export default class Client extends OpenApi {
|
|
|
4134
4150
|
}
|
|
4135
4151
|
|
|
4136
4152
|
/**
|
|
4137
|
-
* Retrieves HTTP API
|
|
4153
|
+
* Retrieves the information of an HTTP API.
|
|
4138
4154
|
*
|
|
4139
4155
|
* @param request - GetHttpApiRequest
|
|
4140
4156
|
* @param headers - map
|
|
@@ -4167,7 +4183,7 @@ export default class Client extends OpenApi {
|
|
|
4167
4183
|
}
|
|
4168
4184
|
|
|
4169
4185
|
/**
|
|
4170
|
-
* Retrieves HTTP API
|
|
4186
|
+
* Retrieves the information of an HTTP API.
|
|
4171
4187
|
*
|
|
4172
4188
|
* @param request - GetHttpApiRequest
|
|
4173
4189
|
* @returns GetHttpApiResponse
|
|
@@ -4838,7 +4854,7 @@ export default class Client extends OpenApi {
|
|
|
4838
4854
|
}
|
|
4839
4855
|
|
|
4840
4856
|
/**
|
|
4841
|
-
* Imports an HTTP API.
|
|
4857
|
+
* Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
|
|
4842
4858
|
*
|
|
4843
4859
|
* @param request - ImportHttpApiRequest
|
|
4844
4860
|
* @param headers - map
|
|
@@ -4923,7 +4939,7 @@ export default class Client extends OpenApi {
|
|
|
4923
4939
|
}
|
|
4924
4940
|
|
|
4925
4941
|
/**
|
|
4926
|
-
* Imports an HTTP API.
|
|
4942
|
+
* Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
|
|
4927
4943
|
*
|
|
4928
4944
|
* @param request - ImportHttpApiRequest
|
|
4929
4945
|
* @returns ImportHttpApiResponse
|
|
@@ -5295,7 +5311,7 @@ export default class Client extends OpenApi {
|
|
|
5295
5311
|
}
|
|
5296
5312
|
|
|
5297
5313
|
/**
|
|
5298
|
-
* Retrieves
|
|
5314
|
+
* Retrieves a list of consumer authorization rules.
|
|
5299
5315
|
*
|
|
5300
5316
|
* @param request - ListConsumerAuthorizationRulesRequest
|
|
5301
5317
|
* @param headers - map
|
|
@@ -5336,7 +5352,7 @@ export default class Client extends OpenApi {
|
|
|
5336
5352
|
}
|
|
5337
5353
|
|
|
5338
5354
|
/**
|
|
5339
|
-
* Retrieves
|
|
5355
|
+
* Retrieves a list of consumer authorization rules.
|
|
5340
5356
|
*
|
|
5341
5357
|
* @param request - ListConsumerAuthorizationRulesRequest
|
|
5342
5358
|
* @returns ListConsumerAuthorizationRulesResponse
|
|
@@ -6909,7 +6925,7 @@ export default class Client extends OpenApi {
|
|
|
6909
6925
|
}
|
|
6910
6926
|
|
|
6911
6927
|
/**
|
|
6912
|
-
* Retrieves the
|
|
6928
|
+
* Retrieves the plug-in mount list.
|
|
6913
6929
|
*
|
|
6914
6930
|
* @param request - ListPluginAttachmentsRequest
|
|
6915
6931
|
* @param headers - map
|
|
@@ -6974,7 +6990,7 @@ export default class Client extends OpenApi {
|
|
|
6974
6990
|
}
|
|
6975
6991
|
|
|
6976
6992
|
/**
|
|
6977
|
-
* Retrieves the
|
|
6993
|
+
* Retrieves the plug-in mount list.
|
|
6978
6994
|
*
|
|
6979
6995
|
* @param request - ListPluginAttachmentsRequest
|
|
6980
6996
|
* @returns ListPluginAttachmentsResponse
|
|
@@ -8849,7 +8865,7 @@ export default class Client extends OpenApi {
|
|
|
8849
8865
|
* Updates a consumer authorization rule.
|
|
8850
8866
|
*
|
|
8851
8867
|
* @remarks
|
|
8852
|
-
*
|
|
8868
|
+
* 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
8869
|
*
|
|
8854
8870
|
* @param request - UpdateConsumerAuthorizationRuleRequest
|
|
8855
8871
|
* @param headers - map
|
|
@@ -8893,7 +8909,7 @@ export default class Client extends OpenApi {
|
|
|
8893
8909
|
* Updates a consumer authorization rule.
|
|
8894
8910
|
*
|
|
8895
8911
|
* @remarks
|
|
8896
|
-
*
|
|
8912
|
+
* 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
8913
|
*
|
|
8898
8914
|
* @param request - UpdateConsumerAuthorizationRuleRequest
|
|
8899
8915
|
* @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.
|
|
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.
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
101
|
-
* - consumer: API consumer.
|
|
102
|
-
* - consumer_group: API consumer group.
|
|
100
|
+
* The subject type of the rule. Valid values:
|
|
103
101
|
*
|
|
104
|
-
*
|
|
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
|
|
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
|
|
121
|
-
*
|
|
122
|
-
* -
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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
|
|
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
|
|
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
|
|
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
|
-
* -
|
|
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
|
|
|
@@ -24,7 +24,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
|
|
|
24
24
|
environmentId?: string;
|
|
25
25
|
/**
|
|
26
26
|
* @remarks
|
|
27
|
-
* The Ingress
|
|
27
|
+
* The Ingress class to listen on.
|
|
28
28
|
*
|
|
29
29
|
* @example
|
|
30
30
|
* mse
|
|
@@ -32,7 +32,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
|
|
|
32
32
|
ingressClass?: string;
|
|
33
33
|
/**
|
|
34
34
|
* @remarks
|
|
35
|
-
* Specifies whether to update the address in the Ingress
|
|
35
|
+
* Specifies whether to update the address in the Ingress status.
|
|
36
36
|
*
|
|
37
37
|
* @example
|
|
38
38
|
* false
|
|
@@ -90,22 +90,22 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
|
|
|
90
90
|
export class CreateHttpApiRequest extends $dara.Model {
|
|
91
91
|
/**
|
|
92
92
|
* @remarks
|
|
93
|
-
* The list of protocols supported by the agent.
|
|
93
|
+
* The list of protocols supported by the agent. This parameter is required when type is set to Agent. You do not need to specify this parameter for other types.
|
|
94
94
|
*/
|
|
95
95
|
agentProtocols?: string[];
|
|
96
96
|
/**
|
|
97
97
|
* @remarks
|
|
98
|
-
* The list of AI API protocols.
|
|
98
|
+
* The list of AI API protocols. This parameter is required when type is set to LLM, and only one protocol can be specified. This parameter is required when type is set to Ai, and multiple protocols can be specified. You do not need to specify this parameter for other types. Example protocol entry: OpenAI/v1.
|
|
99
99
|
*/
|
|
100
100
|
aiProtocols?: string[];
|
|
101
101
|
/**
|
|
102
102
|
* @remarks
|
|
103
|
-
* The authentication configuration.
|
|
103
|
+
* The authentication configuration. This parameter is required when enableAuth is set to true.
|
|
104
104
|
*/
|
|
105
105
|
authConfig?: AuthConfig;
|
|
106
106
|
/**
|
|
107
107
|
* @remarks
|
|
108
|
-
* The
|
|
108
|
+
* The base path of the API. The value must start with a forward slash (/), cannot exceed 256 bytes in length, and cannot contain spaces. This parameter is required when type is set to Rest. When type is set to LLM, Ai, or Agent, this parameter is optional and defaults to /.
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
111
|
* /v1
|
|
@@ -121,12 +121,12 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
121
121
|
belongGatewayId?: string;
|
|
122
122
|
/**
|
|
123
123
|
* @remarks
|
|
124
|
-
* The list of deployment configurations for the HTTP API.
|
|
124
|
+
* The list of deployment configurations for the HTTP API. This parameter is required when type is set to LLM or Ai, and only one deployment configuration can be specified. This parameter is not validated at the request level for other types.
|
|
125
125
|
*/
|
|
126
126
|
deployConfigs?: HttpApiDeployConfig[];
|
|
127
127
|
/**
|
|
128
128
|
* @remarks
|
|
129
|
-
* The API
|
|
129
|
+
* The description of the API.
|
|
130
130
|
*
|
|
131
131
|
* @example
|
|
132
132
|
* Test API for integration
|
|
@@ -144,7 +144,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
144
144
|
dryRun?: boolean;
|
|
145
145
|
/**
|
|
146
146
|
* @remarks
|
|
147
|
-
* Specifies whether to enable authentication.
|
|
147
|
+
* Specifies whether to enable authentication. This parameter is validated when type is set to LLM, Ai, or Agent. This parameter is not validated at the request level when type is set to Rest.
|
|
148
148
|
*
|
|
149
149
|
* @example
|
|
150
150
|
* true
|
|
@@ -160,12 +160,20 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
160
160
|
firstByteTimeout?: number;
|
|
161
161
|
/**
|
|
162
162
|
* @remarks
|
|
163
|
-
* The HTTP Ingress API configuration.
|
|
163
|
+
* The HTTP Ingress API configuration. This parameter is required and cannot be nil when type is set to HttpIngress. You do not need to specify this parameter for other types.
|
|
164
164
|
*/
|
|
165
165
|
ingressConfig?: CreateHttpApiRequestIngressConfig;
|
|
166
166
|
/**
|
|
167
167
|
* @remarks
|
|
168
|
-
* The AI model category.
|
|
168
|
+
* The AI model category. This parameter is optional when type is set to LLM or Ai. You do not need to specify this parameter for other types. Valid values:
|
|
169
|
+
* - Text: text generation.
|
|
170
|
+
* - Image: image generation.
|
|
171
|
+
* - Audio: audio processing.
|
|
172
|
+
* - Video: AI video generation.
|
|
173
|
+
* - MultiModal: multimodal.
|
|
174
|
+
* - Embedding: embedding.
|
|
175
|
+
* - Rerank: reranking.
|
|
176
|
+
* - Others: other.
|
|
169
177
|
*
|
|
170
178
|
* @example
|
|
171
179
|
* Text
|
|
@@ -173,7 +181,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
173
181
|
modelCategory?: string;
|
|
174
182
|
/**
|
|
175
183
|
* @remarks
|
|
176
|
-
* The name of the HTTP API,
|
|
184
|
+
* The name of the HTTP API, which identifies the API resource. Example: test-api.
|
|
177
185
|
*
|
|
178
186
|
* This parameter is required.
|
|
179
187
|
*
|
|
@@ -212,7 +220,13 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
212
220
|
strategy?: string;
|
|
213
221
|
/**
|
|
214
222
|
* @remarks
|
|
215
|
-
* The HTTP API type. Valid values:
|
|
223
|
+
* The HTTP API type. Valid values:
|
|
224
|
+
* - Http: a standard HTTP API.
|
|
225
|
+
* - Rest: a RESTful API.
|
|
226
|
+
* - WebSocket: a WebSocket API.
|
|
227
|
+
* - HttpIngress: an HTTP API accessed through Ingress.
|
|
228
|
+
* - LLM: a large language model API.
|
|
229
|
+
* - Agent: an agent proxy API.
|
|
216
230
|
*
|
|
217
231
|
* This parameter is required.
|
|
218
232
|
*
|
|
@@ -225,6 +239,14 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
225
239
|
* The API versioning configuration.
|
|
226
240
|
*/
|
|
227
241
|
versionConfig?: HttpApiVersionConfig;
|
|
242
|
+
/**
|
|
243
|
+
* @remarks
|
|
244
|
+
* The idempotency token, which is a globally unique value generated by the caller. We recommend that you use a UUID. The value cannot exceed 64 characters in length. Within approximately 24 hours after the first successful request, a duplicate request that carries the same ClientToken and identical request parameters directly returns the httpApiId created by the first request without creating a duplicate HTTP API. If the same ClientToken is carried but the request parameters are different, the IdempotentParameterMismatch error is returned. If the first request is still being processed, the IdempotentProcessing error is returned. If this parameter is not specified, idempotency control is not enabled, and the behavior is consistent with the existing version.
|
|
245
|
+
*
|
|
246
|
+
* @example
|
|
247
|
+
* 5f7a2c1e-9b3d-4e8f-a1c6-0d2b8e4f7a13
|
|
248
|
+
*/
|
|
249
|
+
clientToken?: string;
|
|
228
250
|
static names(): { [key: string]: string } {
|
|
229
251
|
return {
|
|
230
252
|
agentProtocols: 'agentProtocols',
|
|
@@ -246,6 +268,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
246
268
|
strategy: 'strategy',
|
|
247
269
|
type: 'type',
|
|
248
270
|
versionConfig: 'versionConfig',
|
|
271
|
+
clientToken: 'clientToken',
|
|
249
272
|
};
|
|
250
273
|
}
|
|
251
274
|
|
|
@@ -270,6 +293,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
270
293
|
strategy: 'string',
|
|
271
294
|
type: 'string',
|
|
272
295
|
versionConfig: HttpApiVersionConfig,
|
|
296
|
+
clientToken: 'string',
|
|
273
297
|
};
|
|
274
298
|
}
|
|
275
299
|
|
|
@@ -9,7 +9,7 @@ import { HttpDubboTranscoder } from "./HttpDubboTranscoder";
|
|
|
9
9
|
export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model {
|
|
10
10
|
/**
|
|
11
11
|
* @remarks
|
|
12
|
-
* The service group. Used in
|
|
12
|
+
* The service group. Used in HTTP-to-Dubbo transcoding scenarios.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* DEFAULT_GROUP
|
|
@@ -17,7 +17,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
17
17
|
groupName?: string;
|
|
18
18
|
/**
|
|
19
19
|
* @remarks
|
|
20
|
-
* The HTTP-to-Dubbo protocol
|
|
20
|
+
* The HTTP-to-Dubbo protocol transcoding configuration. Only supported for SingleService MSE_NACOS DUBBO backends of HTTP APIs.
|
|
21
21
|
*
|
|
22
22
|
* @example
|
|
23
23
|
* {"dubboServiceName":"com.alibaba.nacos.example.dubbo.service.DemoService","dubboServiceVersion":"1.0.0","dubboServiceGroup":"DEV","methodMapList":[{"dubboMethodName":"sayName","httpMethod":"ALL_GET","methodPath":"/dubbo/sayName","passThroughAllHeaders":"PASS_ALL"}]}
|
|
@@ -25,7 +25,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
25
25
|
httpDubboTranscoder?: HttpDubboTranscoder;
|
|
26
26
|
/**
|
|
27
27
|
* @remarks
|
|
28
|
-
* The target model name. This field is shared by multiple model backend scenarios. The specific routing or model rewrite semantics are determined by backendConfig.scene. This field is required for the SemanticRouter scenario. If not specified in the AiAutoRouter scenario, the default model of the AI service is used.
|
|
28
|
+
* The target model name. This field is shared by multiple existing model backend scenarios. The specific routing or model rewrite semantics are determined by backendConfig.scene. This field is required for the SemanticRouter scenario. If not specified in the AiAutoRouter scenario, the default model of the AI service is used.
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
31
|
* qwen-plus
|
|
@@ -33,7 +33,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
33
33
|
modelName?: string;
|
|
34
34
|
/**
|
|
35
35
|
* @remarks
|
|
36
|
-
* The service namespace. Used in
|
|
36
|
+
* The service namespace. Used in HTTP-to-Dubbo transcoding scenarios.
|
|
37
37
|
*
|
|
38
38
|
* @example
|
|
39
39
|
* public
|
|
@@ -49,7 +49,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
49
49
|
port?: number;
|
|
50
50
|
/**
|
|
51
51
|
* @remarks
|
|
52
|
-
* The
|
|
52
|
+
* The Terms of Service. Valid values:
|
|
53
53
|
* - HTTP.
|
|
54
54
|
* - HTTPS.
|
|
55
55
|
*
|
|
@@ -67,7 +67,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
67
67
|
serviceId?: string;
|
|
68
68
|
/**
|
|
69
69
|
* @remarks
|
|
70
|
-
* The service source type. Used in
|
|
70
|
+
* The service source type. Used in HTTP-to-Dubbo transcoding scenarios.
|
|
71
71
|
*
|
|
72
72
|
* @example
|
|
73
73
|
* MSE_NACOS
|
|
@@ -75,7 +75,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
75
75
|
sourceType?: string;
|
|
76
76
|
/**
|
|
77
77
|
* @remarks
|
|
78
|
-
* The service version. This parameter
|
|
78
|
+
* The service version. This parameter takes effect only in tag-based scenarios.
|
|
79
79
|
*
|
|
80
80
|
* @example
|
|
81
81
|
* v1
|
|
@@ -83,7 +83,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
|
|
|
83
83
|
version?: string;
|
|
84
84
|
/**
|
|
85
85
|
* @remarks
|
|
86
|
-
* The traffic ratio
|
|
86
|
+
* The percentage value of the traffic ratio.
|
|
87
87
|
*
|
|
88
88
|
* @example
|
|
89
89
|
* 49
|
|
@@ -194,7 +194,7 @@ export class CreateHttpApiRouteRequestMcpRouteConfig extends $dara.Model {
|
|
|
194
194
|
mcpStatisticsEnable?: boolean;
|
|
195
195
|
/**
|
|
196
196
|
* @remarks
|
|
197
|
-
* The
|
|
197
|
+
* The Terms of Service. Valid values:
|
|
198
198
|
* - TCP.
|
|
199
199
|
* - HTTP.
|
|
200
200
|
* - DUBBO.
|
|
@@ -264,7 +264,7 @@ export class CreateHttpApiRouteRequest extends $dara.Model {
|
|
|
264
264
|
environmentId?: string;
|
|
265
265
|
/**
|
|
266
266
|
* @remarks
|
|
267
|
-
* The route match
|
|
267
|
+
* The route match rules.
|
|
268
268
|
*/
|
|
269
269
|
match?: HttpRouteMatch;
|
|
270
270
|
/**
|
|
@@ -10,7 +10,7 @@ export class CreatePluginAttachmentRequest extends $dara.Model {
|
|
|
10
10
|
attachResourceIds?: string[];
|
|
11
11
|
/**
|
|
12
12
|
* @remarks
|
|
13
|
-
* The resource type to which the plug-in is mounted. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi,
|
|
13
|
+
* The resource type to which the plug-in is mounted. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, Operation.
|
|
14
14
|
*
|
|
15
15
|
* @example
|
|
16
16
|
* HttpApi
|
|
@@ -42,7 +42,7 @@ export class CreatePluginAttachmentRequest extends $dara.Model {
|
|
|
42
42
|
gatewayId?: string;
|
|
43
43
|
/**
|
|
44
44
|
* @remarks
|
|
45
|
-
* The Base64-encoded content of the
|
|
45
|
+
* The Base64-encoded content of the plug-in configuration.
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K
|