@alicloud/apig20240327 11.3.1 → 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.
- package/dist/client.d.ts +24 -24
- package/dist/client.js +35 -24
- 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 +28 -14
- package/dist/models/CreateHttpApiRequest.js.map +1 -1
- package/dist/models/CreateHttpApiRouteRequest.d.ts +8 -8
- 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/DeleteHttpApiRequest.d.ts +9 -1
- package/dist/models/DeleteHttpApiRequest.js +2 -0
- package/dist/models/DeleteHttpApiRequest.js.map +1 -1
- package/dist/models/DeployHttpApiRequest.d.ts +11 -11
- package/dist/models/GetDashboardRequest.d.ts +6 -6
- package/dist/models/GetDashboardResponseBody.d.ts +1 -1
- package/dist/models/GetDashboardShrinkRequest.d.ts +6 -6
- package/dist/models/GetHttpApiOperationResponseBody.d.ts +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/ListPluginAttachmentsRequest.d.ts +4 -4
- package/dist/models/ListPluginAttachmentsResponseBody.d.ts +7 -7
- package/dist/models/UpdatePluginAttachmentRequest.d.ts +2 -2
- package/package.json +1 -1
- package/src/client.ts +38 -24
- 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 +28 -14
- package/src/models/CreateHttpApiRouteRequest.ts +8 -8
- 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/DeleteHttpApiRequest.ts +11 -1
- package/src/models/DeployHttpApiRequest.ts +11 -11
- package/src/models/GetDashboardRequest.ts +6 -6
- package/src/models/GetDashboardResponseBody.ts +1 -1
- package/src/models/GetDashboardShrinkRequest.ts +6 -6
- package/src/models/GetHttpApiOperationResponseBody.ts +1 -1
- 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/ListPluginAttachmentsRequest.ts +4 -4
- package/src/models/ListPluginAttachmentsResponseBody.ts +7 -7
- 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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
18
|
+
* The Base64-encoded content of the raw plugin configuration.
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
21
|
* cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K
|
package/package.json
CHANGED
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({
|
|
@@ -1425,7 +1435,7 @@ export default class Client extends OpenApi {
|
|
|
1425
1435
|
}
|
|
1426
1436
|
|
|
1427
1437
|
/**
|
|
1428
|
-
* Creates
|
|
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
|
|
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
|
|
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
|
|
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
|
|
2686
|
+
* Deletes a quota throttling rule for a gateway.
|
|
2677
2687
|
*
|
|
2678
2688
|
* @remarks
|
|
2679
|
-
*
|
|
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
|
|
2716
|
+
* Deletes a quota throttling rule for a gateway.
|
|
2707
2717
|
*
|
|
2708
2718
|
* @remarks
|
|
2709
|
-
*
|
|
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
|
|
@@ -2773,6 +2783,10 @@ export default class Client extends OpenApi {
|
|
|
2773
2783
|
async deleteHttpApiWithOptions(httpApiId: string, request: $_model.DeleteHttpApiRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteHttpApiResponse> {
|
|
2774
2784
|
request.validate();
|
|
2775
2785
|
let query : {[key: string ]: any} = { };
|
|
2786
|
+
if (!$dara.isNull(request.clientToken)) {
|
|
2787
|
+
query["clientToken"] = request.clientToken;
|
|
2788
|
+
}
|
|
2789
|
+
|
|
2776
2790
|
if (!$dara.isNull(request.dryRun)) {
|
|
2777
2791
|
query["dryRun"] = request.dryRun;
|
|
2778
2792
|
}
|
|
@@ -4130,7 +4144,7 @@ export default class Client extends OpenApi {
|
|
|
4130
4144
|
}
|
|
4131
4145
|
|
|
4132
4146
|
/**
|
|
4133
|
-
* Retrieves HTTP API
|
|
4147
|
+
* Retrieves the information of an HTTP API.
|
|
4134
4148
|
*
|
|
4135
4149
|
* @param request - GetHttpApiRequest
|
|
4136
4150
|
* @param headers - map
|
|
@@ -4163,7 +4177,7 @@ export default class Client extends OpenApi {
|
|
|
4163
4177
|
}
|
|
4164
4178
|
|
|
4165
4179
|
/**
|
|
4166
|
-
* Retrieves HTTP API
|
|
4180
|
+
* Retrieves the information of an HTTP API.
|
|
4167
4181
|
*
|
|
4168
4182
|
* @param request - GetHttpApiRequest
|
|
4169
4183
|
* @returns GetHttpApiResponse
|
|
@@ -4175,7 +4189,7 @@ export default class Client extends OpenApi {
|
|
|
4175
4189
|
}
|
|
4176
4190
|
|
|
4177
4191
|
/**
|
|
4178
|
-
* Retrieves operation information.
|
|
4192
|
+
* Retrieves the API operation information.
|
|
4179
4193
|
*
|
|
4180
4194
|
* @param headers - map
|
|
4181
4195
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4200,7 +4214,7 @@ export default class Client extends OpenApi {
|
|
|
4200
4214
|
}
|
|
4201
4215
|
|
|
4202
4216
|
/**
|
|
4203
|
-
* Retrieves operation information.
|
|
4217
|
+
* Retrieves the API operation information.
|
|
4204
4218
|
* @returns GetHttpApiOperationResponse
|
|
4205
4219
|
*/
|
|
4206
4220
|
async getHttpApiOperation(httpApiId: string, operationId: string): Promise<$_model.GetHttpApiOperationResponse> {
|
|
@@ -4834,7 +4848,7 @@ export default class Client extends OpenApi {
|
|
|
4834
4848
|
}
|
|
4835
4849
|
|
|
4836
4850
|
/**
|
|
4837
|
-
* Imports an HTTP API.
|
|
4851
|
+
* Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
|
|
4838
4852
|
*
|
|
4839
4853
|
* @param request - ImportHttpApiRequest
|
|
4840
4854
|
* @param headers - map
|
|
@@ -4919,7 +4933,7 @@ export default class Client extends OpenApi {
|
|
|
4919
4933
|
}
|
|
4920
4934
|
|
|
4921
4935
|
/**
|
|
4922
|
-
* Imports an HTTP API.
|
|
4936
|
+
* Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
|
|
4923
4937
|
*
|
|
4924
4938
|
* @param request - ImportHttpApiRequest
|
|
4925
4939
|
* @returns ImportHttpApiResponse
|
|
@@ -5291,7 +5305,7 @@ export default class Client extends OpenApi {
|
|
|
5291
5305
|
}
|
|
5292
5306
|
|
|
5293
5307
|
/**
|
|
5294
|
-
* Retrieves
|
|
5308
|
+
* Retrieves a list of consumer authorization rules.
|
|
5295
5309
|
*
|
|
5296
5310
|
* @param request - ListConsumerAuthorizationRulesRequest
|
|
5297
5311
|
* @param headers - map
|
|
@@ -5332,7 +5346,7 @@ export default class Client extends OpenApi {
|
|
|
5332
5346
|
}
|
|
5333
5347
|
|
|
5334
5348
|
/**
|
|
5335
|
-
* Retrieves
|
|
5349
|
+
* Retrieves a list of consumer authorization rules.
|
|
5336
5350
|
*
|
|
5337
5351
|
* @param request - ListConsumerAuthorizationRulesRequest
|
|
5338
5352
|
* @returns ListConsumerAuthorizationRulesResponse
|
|
@@ -6905,7 +6919,7 @@ export default class Client extends OpenApi {
|
|
|
6905
6919
|
}
|
|
6906
6920
|
|
|
6907
6921
|
/**
|
|
6908
|
-
* Retrieves the
|
|
6922
|
+
* Retrieves the plug-in mount list.
|
|
6909
6923
|
*
|
|
6910
6924
|
* @param request - ListPluginAttachmentsRequest
|
|
6911
6925
|
* @param headers - map
|
|
@@ -6970,7 +6984,7 @@ export default class Client extends OpenApi {
|
|
|
6970
6984
|
}
|
|
6971
6985
|
|
|
6972
6986
|
/**
|
|
6973
|
-
* Retrieves the
|
|
6987
|
+
* Retrieves the plug-in mount list.
|
|
6974
6988
|
*
|
|
6975
6989
|
* @param request - ListPluginAttachmentsRequest
|
|
6976
6990
|
* @returns ListPluginAttachmentsResponse
|
|
@@ -8845,7 +8859,7 @@ export default class Client extends OpenApi {
|
|
|
8845
8859
|
* Updates a consumer authorization rule.
|
|
8846
8860
|
*
|
|
8847
8861
|
* @remarks
|
|
8848
|
-
*
|
|
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.
|
|
8849
8863
|
*
|
|
8850
8864
|
* @param request - UpdateConsumerAuthorizationRuleRequest
|
|
8851
8865
|
* @param headers - map
|
|
@@ -8889,7 +8903,7 @@ export default class Client extends OpenApi {
|
|
|
8889
8903
|
* Updates a consumer authorization rule.
|
|
8890
8904
|
*
|
|
8891
8905
|
* @remarks
|
|
8892
|
-
*
|
|
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.
|
|
8893
8907
|
*
|
|
8894
8908
|
* @param request - UpdateConsumerAuthorizationRuleRequest
|
|
8895
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.
|
|
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
|