@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
|
@@ -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. Required when type is Agent.
|
|
93
|
+
* The list of protocols supported by the agent. Required when type is Agent. This field is not required for other types.
|
|
94
94
|
*/
|
|
95
95
|
agentProtocols?: string[];
|
|
96
96
|
/**
|
|
97
97
|
* @remarks
|
|
98
|
-
* The list of AI API protocols. Required when type is LLM
|
|
98
|
+
* The list of AI API protocols. Required when type is LLM (only one protocol allowed) or Ai (multiple protocols allowed). Not required for other types. Example protocol: OpenAI/v1.
|
|
99
99
|
*/
|
|
100
100
|
aiProtocols?: string[];
|
|
101
101
|
/**
|
|
102
102
|
* @remarks
|
|
103
|
-
* The authentication configuration. Required when enableAuth
|
|
103
|
+
* The authentication configuration. 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. Must start with a forward slash (/), cannot exceed 256 bytes in length, and cannot contain spaces. Required when type is Rest. Optional when type is LLM, Ai, or Agent. Defaults to /.
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
111
|
* /v1
|
|
@@ -121,7 +121,7 @@ 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. Required when type is LLM or Ai
|
|
124
|
+
* The list of deployment configurations for the HTTP API. Required when type is LLM or Ai (only one deployment configuration allowed). Not validated at the request level for other types.
|
|
125
125
|
*/
|
|
126
126
|
deployConfigs?: HttpApiDeployConfig[];
|
|
127
127
|
/**
|
|
@@ -134,7 +134,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
134
134
|
description?: string;
|
|
135
135
|
/**
|
|
136
136
|
* @remarks
|
|
137
|
-
* Specifies whether to
|
|
137
|
+
* Specifies whether to preview only without executing.
|
|
138
138
|
*
|
|
139
139
|
* @example
|
|
140
140
|
* true
|
|
@@ -152,7 +152,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
152
152
|
enableAuth?: boolean;
|
|
153
153
|
/**
|
|
154
154
|
* @remarks
|
|
155
|
-
* The timeout period for waiting for the
|
|
155
|
+
* The timeout period for waiting for the backend to return the first byte.
|
|
156
156
|
*
|
|
157
157
|
* @example
|
|
158
158
|
* 30
|
|
@@ -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. Required when type is HttpIngress and cannot be
|
|
163
|
+
* The HTTP Ingress API configuration. Required when type is HttpIngress and cannot be null. Not required for other types.
|
|
164
164
|
*/
|
|
165
165
|
ingressConfig?: CreateHttpApiRequestIngressConfig;
|
|
166
166
|
/**
|
|
167
167
|
* @remarks
|
|
168
|
-
* The AI model category. Optional when type is LLM or Ai. Not required for other types. Valid values:
|
|
168
|
+
* The AI model category. Optional when type is LLM or Ai. Not required for other types. Valid values:
|
|
169
|
+
* - Text: text generation.
|
|
170
|
+
* - Image: image generation.
|
|
171
|
+
* - Audio: audio processing.
|
|
172
|
+
* - Video: video generation.
|
|
173
|
+
* - MultiModal: multimodal.
|
|
174
|
+
* - Embedding: vector embedding.
|
|
175
|
+
* - Rerank: reranking.
|
|
176
|
+
* - Others: others.
|
|
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, used to identify the current API resource.
|
|
184
|
+
* The name of the HTTP API, used to identify the current API resource. For example, test-api.
|
|
177
185
|
*
|
|
178
186
|
* This parameter is required.
|
|
179
187
|
*
|
|
@@ -204,7 +212,7 @@ export class CreateHttpApiRequest extends $dara.Model {
|
|
|
204
212
|
resourceGroupId?: string;
|
|
205
213
|
/**
|
|
206
214
|
* @remarks
|
|
207
|
-
* The conflict
|
|
215
|
+
* The conflict resolution strategy for imports.
|
|
208
216
|
*
|
|
209
217
|
* @example
|
|
210
218
|
* ExistFirst
|
|
@@ -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
|
*
|
|
@@ -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
|
|
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 this field is not specified for 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
|
|
@@ -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 the tag-based scenario.
|
|
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
|
|
@@ -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
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class CreatePolicyAttachmentRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The ID of the resource to
|
|
8
|
+
* The ID of the resource to mount.
|
|
9
9
|
*
|
|
10
10
|
* This parameter is required.
|
|
11
11
|
*
|
|
@@ -15,7 +15,7 @@ export class CreatePolicyAttachmentRequest extends $dara.Model {
|
|
|
15
15
|
attachResourceId?: string;
|
|
16
16
|
/**
|
|
17
17
|
* @remarks
|
|
18
|
-
* The type of the resource to
|
|
18
|
+
* The type of the resource to mount. Valid values: HttpApi, GatewayRoute, Operation, GatewayService, GatewayServicePort, Gateway, Domain.
|
|
19
19
|
*
|
|
20
20
|
* This parameter is required.
|
|
21
21
|
*
|
|
@@ -7,36 +7,36 @@ export class CreatePolicyRequest extends $dara.Model {
|
|
|
7
7
|
* @remarks
|
|
8
8
|
* The policy type. Valid values:
|
|
9
9
|
*
|
|
10
|
-
* - RateLimit:
|
|
11
|
-
* - ConcurrencyLimit:
|
|
12
|
-
* - CircuitBreaker:
|
|
10
|
+
* - RateLimit: Rate limiting. Limits the request rate.
|
|
11
|
+
* - ConcurrencyLimit: Concurrency limiting. Limits the number of concurrent requests.
|
|
12
|
+
* - CircuitBreaker: Circuit breaker. Automatically triggers circuit breaking when backend exceptions occur.
|
|
13
13
|
* - HttpRewrite: HTTP rewrite. Rewrites the request URL or path.
|
|
14
|
-
* - HeaderModify:
|
|
14
|
+
* - HeaderModify: Header modification. Adds, removes, or modifies HTTP request headers.
|
|
15
15
|
* - Cors: Cross-Origin Resource Sharing (CORS). Controls cross-origin requests.
|
|
16
|
-
* - Authentication:
|
|
17
|
-
* - FlowCopy:
|
|
18
|
-
* - Timeout:
|
|
19
|
-
* - Retry:
|
|
20
|
-
* - IpAccessControl: IP access control. Filters requests based on IP whitelists and blacklists.
|
|
21
|
-
* - DirectResponse:
|
|
22
|
-
* - Redirect:
|
|
23
|
-
* - Fallback:
|
|
24
|
-
* - ServiceTls:
|
|
25
|
-
* - ServiceLb:
|
|
26
|
-
* - ServicePortTls:
|
|
16
|
+
* - Authentication: General authentication. A general request authentication policy.
|
|
17
|
+
* - FlowCopy: Traffic mirroring. Copies requests to an additional backend.
|
|
18
|
+
* - Timeout: Timeout. Sets the request timeout period.
|
|
19
|
+
* - Retry: Retry. Automatically retries failed requests.
|
|
20
|
+
* - IpAccessControl: IP access control. Filters requests based on IP address whitelists and blacklists.
|
|
21
|
+
* - DirectResponse: Direct response. Returns a fixed response directly.
|
|
22
|
+
* - Redirect: Redirect. Redirects requests to another address.
|
|
23
|
+
* - Fallback: Fallback. Returns a fallback response when the backend is unavailable.
|
|
24
|
+
* - ServiceTls: Service TLS. Configures TLS for backend services.
|
|
25
|
+
* - ServiceLb: Service load balancing. Configures load balancing for backend services.
|
|
26
|
+
* - ServicePortTls: Service port TLS. Configures TLS for backend service ports.
|
|
27
27
|
* - Waf: Web Application Firewall (WAF). Provides request security protection.
|
|
28
28
|
* - JWTAuth: JWT authentication. Authenticates requests based on JSON Web Tokens (JWT).
|
|
29
29
|
* - OIDCAuth: OIDC authentication. Authenticates requests based on the OpenID Connect (OIDC) protocol.
|
|
30
|
-
* - ExternalZAuth:
|
|
30
|
+
* - ExternalZAuth: External authentication. Integrates with an external authentication service.
|
|
31
31
|
* - AiProxy: AI proxy.
|
|
32
|
-
* - ModelRouter:
|
|
32
|
+
* - ModelRouter: Model router.
|
|
33
33
|
* - AiStatistics: AI statistics.
|
|
34
34
|
* - AiSecurityGuard: AI security guard. Detects the security of AI request and response content.
|
|
35
35
|
* - AiFallback: AI fallback. Falls back to an alternative model when the AI service is unavailable.
|
|
36
|
-
* - ModelMapper:
|
|
36
|
+
* - ModelMapper: Model mapper.
|
|
37
37
|
* - AiTokenRateLimit: AI token rate limiting. Limits the rate based on token consumption.
|
|
38
38
|
* - AiCache: AI cache. Caches AI response results.
|
|
39
|
-
* - DynamicRoute:
|
|
39
|
+
* - DynamicRoute: Dynamic route.
|
|
40
40
|
*
|
|
41
41
|
* This parameter is required.
|
|
42
42
|
*
|
|
@@ -56,10 +56,10 @@ export class CreatePolicyRequest extends $dara.Model {
|
|
|
56
56
|
config?: string;
|
|
57
57
|
/**
|
|
58
58
|
* @remarks
|
|
59
|
-
* The description.
|
|
59
|
+
* The description of the policy.
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
|
-
*
|
|
62
|
+
* Timeout policy
|
|
63
63
|
*/
|
|
64
64
|
description?: string;
|
|
65
65
|
/**
|
|
@@ -5,17 +5,27 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class DeleteHttpApiRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
*
|
|
8
|
+
* The idempotence token. If you call this operation multiple times for the same HTTP API by using the same clientToken value and the same delete request parameters, the result of the first successful call is returned.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* delete-http-api-client-token-001
|
|
12
|
+
*/
|
|
13
|
+
clientToken?: string;
|
|
14
|
+
/**
|
|
15
|
+
* @remarks
|
|
16
|
+
* Specifies whether to perform only a dry run. If set to true, all synchronous validations identical to an actual deletion are executed (including admission checks such as whether a published API can be deleted), but the API is not deleted, no associated configurations are cleaned up, and no side effects are produced. If this parameter is not specified or is set to false, the behavior is the same as the existing version.
|
|
9
17
|
*/
|
|
10
18
|
dryRun?: boolean;
|
|
11
19
|
static names(): { [key: string]: string } {
|
|
12
20
|
return {
|
|
21
|
+
clientToken: 'clientToken',
|
|
13
22
|
dryRun: 'dryRun',
|
|
14
23
|
};
|
|
15
24
|
}
|
|
16
25
|
|
|
17
26
|
static types(): { [key: string]: any } {
|
|
18
27
|
return {
|
|
28
|
+
clientToken: 'string',
|
|
19
29
|
dryRun: 'boolean',
|
|
20
30
|
};
|
|
21
31
|
}
|
|
@@ -46,7 +46,7 @@ export class DeployHttpApiRequestHttpApiConfig extends $dara.Model {
|
|
|
46
46
|
export class DeployHttpApiRequestRestApiConfigEnvironmentServiceConfigs extends $dara.Model {
|
|
47
47
|
/**
|
|
48
48
|
* @remarks
|
|
49
|
-
* The match condition configuration
|
|
49
|
+
* The match condition configuration for API publishing.
|
|
50
50
|
*
|
|
51
51
|
* @example
|
|
52
52
|
* {\\"change_order_revision\\":\\"3.657.33_fc-hz-yunqi.1662568293908382_faas-eerouter\\"}
|
|
@@ -63,8 +63,8 @@ export class DeployHttpApiRequestRestApiConfigEnvironmentServiceConfigs extends
|
|
|
63
63
|
/**
|
|
64
64
|
* @remarks
|
|
65
65
|
* The service protocol. Valid values:
|
|
66
|
-
* - HTTP
|
|
67
|
-
* - HTTPS
|
|
66
|
+
* - HTTP.
|
|
67
|
+
* - HTTPS.
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
70
|
* HTTP
|
|
@@ -131,7 +131,7 @@ export class DeployHttpApiRequestRestApiConfigEnvironmentServiceConfigs extends
|
|
|
131
131
|
export class DeployHttpApiRequestRestApiConfigEnvironment extends $dara.Model {
|
|
132
132
|
/**
|
|
133
133
|
* @remarks
|
|
134
|
-
* The API publish scenario. Backend configurations cannot be specified during publishing. Configure them in advance by
|
|
134
|
+
* The API publish scenario. Backend configurations cannot be specified during publishing. Configure them in advance by calling UpdateHttpApi or UpdateHttpApiOperation before publishing.
|
|
135
135
|
*
|
|
136
136
|
* @example
|
|
137
137
|
* SingleService
|
|
@@ -156,7 +156,7 @@ export class DeployHttpApiRequestRestApiConfigEnvironment extends $dara.Model {
|
|
|
156
156
|
environmentId?: string;
|
|
157
157
|
/**
|
|
158
158
|
* @remarks
|
|
159
|
-
* The existing service configurations. In the single-service scenario, only one entry is allowed. In ratio-based or content-based scenarios, multiple entries are allowed. Backend configurations cannot be specified during publishing. Configure them in advance by
|
|
159
|
+
* The existing service configurations. In the single-service scenario, only one entry is allowed. In ratio-based or content-based scenarios, multiple entries are allowed. Backend configurations cannot be specified during publishing. Configure them in advance by calling UpdateHttpApi or UpdateHttpApiOperation before publishing.
|
|
160
160
|
*
|
|
161
161
|
* **if can be null:**
|
|
162
162
|
* true
|
|
@@ -240,7 +240,7 @@ export class DeployHttpApiRequestRestApiConfigOperationDeployments extends $dara
|
|
|
240
240
|
export class DeployHttpApiRequestRestApiConfig extends $dara.Model {
|
|
241
241
|
/**
|
|
242
242
|
* @remarks
|
|
243
|
-
* The publish
|
|
243
|
+
* The description of the publish.
|
|
244
244
|
*
|
|
245
245
|
* @example
|
|
246
246
|
* User service API publish
|
|
@@ -248,7 +248,7 @@ export class DeployHttpApiRequestRestApiConfig extends $dara.Model {
|
|
|
248
248
|
description?: string;
|
|
249
249
|
/**
|
|
250
250
|
* @remarks
|
|
251
|
-
* Specifies whether to enable REST API route compression. If this parameter is omitted or set to false, operations are published individually. If set to true, the API is published as a single prefix route. This
|
|
251
|
+
* Specifies whether to enable REST API route compression. If this parameter is omitted or set to false, operations are published individually. If this parameter is set to true, the API is published as a single prefix route. This parameter is ignored for historical revision publishing, which uses the routing mode saved in the historical revision. When set to true, operationDeployments must not be specified because prefix route publishing supports only full publishing.
|
|
252
252
|
*
|
|
253
253
|
* @example
|
|
254
254
|
* true
|
|
@@ -269,7 +269,7 @@ export class DeployHttpApiRequestRestApiConfig extends $dara.Model {
|
|
|
269
269
|
gatewayId?: string;
|
|
270
270
|
/**
|
|
271
271
|
* @remarks
|
|
272
|
-
* The operation-level deployment control list. This parameter takes effect only when enableRouteCompression is omitted or set to false.
|
|
272
|
+
* The operation-level deployment control list. This parameter takes effect only when enableRouteCompression is omitted or set to false. Do not specify this parameter when enableRouteCompression is set to true.
|
|
273
273
|
*/
|
|
274
274
|
operationDeployments?: DeployHttpApiRequestRestApiConfigOperationDeployments[];
|
|
275
275
|
/**
|
|
@@ -281,7 +281,7 @@ export class DeployHttpApiRequestRestApiConfig extends $dara.Model {
|
|
|
281
281
|
operationIds?: string[];
|
|
282
282
|
/**
|
|
283
283
|
* @remarks
|
|
284
|
-
* The historical revision ID. If this
|
|
284
|
+
* The historical revision ID. If this parameter is specified, the publish uses the information from the historical revision.
|
|
285
285
|
*
|
|
286
286
|
* @example
|
|
287
287
|
* apr-xxx
|
|
@@ -339,12 +339,12 @@ export class DeployHttpApiRequest extends $dara.Model {
|
|
|
339
339
|
httpApiConfig?: DeployHttpApiRequestHttpApiConfig;
|
|
340
340
|
/**
|
|
341
341
|
* @remarks
|
|
342
|
-
* The REST API deployment configuration. This parameter is required when the HTTP API
|
|
342
|
+
* The REST API deployment configuration. This parameter is required when the HTTP API to be published is a REST API. At least one of revisionId, environment, or gatewayId must be specified to identify the publish target.
|
|
343
343
|
*/
|
|
344
344
|
restApiConfig?: DeployHttpApiRequestRestApiConfig;
|
|
345
345
|
/**
|
|
346
346
|
* @remarks
|
|
347
|
-
* The route ID. This parameter is required when publishing a route of an HTTP API.
|
|
347
|
+
* The route ID. This parameter is required when publishing a route of an HTTP API. Before deploying with routeId, make sure the target route is associated with a publishable domain name. If the domain name was not configured when the route was created, call UpdateHttpApiRoute to add domainIds.
|
|
348
348
|
*
|
|
349
349
|
* @example
|
|
350
350
|
* hr-cr82undlhtgrl***
|
|
@@ -35,9 +35,9 @@ export class GetDashboardRequestFilter extends $dara.Model {
|
|
|
35
35
|
export class GetDashboardRequest extends $dara.Model {
|
|
36
36
|
/**
|
|
37
37
|
* @remarks
|
|
38
|
-
* The language. Valid values:
|
|
39
|
-
*
|
|
40
|
-
*
|
|
38
|
+
* The response language. Valid values:
|
|
39
|
+
* zh: Chinese
|
|
40
|
+
* en: English
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* zh
|
|
@@ -60,7 +60,7 @@ export class GetDashboardRequest extends $dara.Model {
|
|
|
60
60
|
* @remarks
|
|
61
61
|
* The dashboard name. Valid values:
|
|
62
62
|
* - LOG: access log
|
|
63
|
-
* - PLUGIN:
|
|
63
|
+
* - PLUGIN: plug-in log
|
|
64
64
|
*
|
|
65
65
|
* @example
|
|
66
66
|
* PLUGIN
|
|
@@ -68,7 +68,7 @@ export class GetDashboardRequest extends $dara.Model {
|
|
|
68
68
|
name?: string;
|
|
69
69
|
/**
|
|
70
70
|
* @remarks
|
|
71
|
-
* The
|
|
71
|
+
* The plug-in type ID.
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
74
|
* pls-dn82a9djd8z****
|
|
@@ -76,7 +76,7 @@ export class GetDashboardRequest extends $dara.Model {
|
|
|
76
76
|
pluginClassId?: string;
|
|
77
77
|
/**
|
|
78
78
|
* @remarks
|
|
79
|
-
* The
|
|
79
|
+
* The plug-in ID.
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* inner-ai-search-cvd3mcum1hks660icn10
|
|
@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetDashboardShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The language. Valid values:
|
|
9
|
-
*
|
|
10
|
-
*
|
|
8
|
+
* The response language. Valid values:
|
|
9
|
+
* zh: Chinese
|
|
10
|
+
* en: English
|
|
11
11
|
*
|
|
12
12
|
* @example
|
|
13
13
|
* zh
|
|
@@ -30,7 +30,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
|
|
|
30
30
|
* @remarks
|
|
31
31
|
* The dashboard name. Valid values:
|
|
32
32
|
* - LOG: access log
|
|
33
|
-
* - PLUGIN:
|
|
33
|
+
* - PLUGIN: plug-in log
|
|
34
34
|
*
|
|
35
35
|
* @example
|
|
36
36
|
* PLUGIN
|
|
@@ -38,7 +38,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
|
|
|
38
38
|
name?: string;
|
|
39
39
|
/**
|
|
40
40
|
* @remarks
|
|
41
|
-
* The
|
|
41
|
+
* The plug-in type ID.
|
|
42
42
|
*
|
|
43
43
|
* @example
|
|
44
44
|
* pls-dn82a9djd8z****
|
|
@@ -46,7 +46,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
|
|
|
46
46
|
pluginClassId?: string;
|
|
47
47
|
/**
|
|
48
48
|
* @remarks
|
|
49
|
-
* The
|
|
49
|
+
* The plug-in ID.
|
|
50
50
|
*
|
|
51
51
|
* @example
|
|
52
52
|
* inner-ai-search-cvd3mcum1hks660icn10
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetHttpApiRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* Specifies whether to expand independent policy configurations.
|
|
8
|
+
* Specifies whether to expand independent policy configurations. If omitted or set to true, a complete compatibility view is returned. If set to false, the ModelAPI token throttling managed by the policy returns a policy reference and an optional read-only plugin status. You can use GetPolicy to retrieve the rule body.
|
|
9
9
|
*/
|
|
10
10
|
expandPolicyConfigs?: boolean;
|
|
11
11
|
static names(): { [key: string]: string } {
|