@alicloud/apig20240327 11.3.3 → 11.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/client.d.ts +6 -6
  2. package/dist/client.js +14 -6
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateHttpApiRequest.d.ts +25 -17
  5. package/dist/models/CreateHttpApiRequest.js +2 -0
  6. package/dist/models/CreateHttpApiRequest.js.map +1 -1
  7. package/dist/models/CreateHttpApiRouteRequest.d.ts +4 -4
  8. package/dist/models/CreateMigrationTaskRequest.d.ts +2 -0
  9. package/dist/models/CreateMigrationTaskRequest.js.map +1 -1
  10. package/dist/models/GetConsumerAuthorizationRuleResponseBody.d.ts +2 -3
  11. package/dist/models/GetConsumerAuthorizationRuleResponseBody.js.map +1 -1
  12. package/dist/models/GetDashboardRequest.d.ts +9 -6
  13. package/dist/models/GetDashboardRequest.js.map +1 -1
  14. package/dist/models/GetDashboardResponseBody.d.ts +2 -2
  15. package/dist/models/GetDashboardShrinkRequest.d.ts +9 -6
  16. package/dist/models/GetDashboardShrinkRequest.js.map +1 -1
  17. package/dist/models/GetHttpApiOperationResponseBody.d.ts +1 -1
  18. package/dist/models/HttpApiDeployConfig.d.ts +3 -3
  19. package/dist/models/ListHttpApisRequest.d.ts +9 -9
  20. package/dist/models/QueryConsumerAuthorizationRulesRequest.d.ts +6 -6
  21. package/dist/models/QueryConsumerAuthorizationRulesResponseBody.d.ts +8 -10
  22. package/dist/models/QueryConsumerAuthorizationRulesResponseBody.js.map +1 -1
  23. package/dist/models/UpdateHttpApiRequest.d.ts +14 -6
  24. package/dist/models/UpdateHttpApiRequest.js +2 -0
  25. package/dist/models/UpdateHttpApiRequest.js.map +1 -1
  26. package/package.json +1 -1
  27. package/src/client.ts +16 -6
  28. package/src/models/CreateHttpApiRequest.ts +27 -17
  29. package/src/models/CreateHttpApiRouteRequest.ts +4 -4
  30. package/src/models/CreateMigrationTaskRequest.ts +2 -0
  31. package/src/models/GetConsumerAuthorizationRuleResponseBody.ts +2 -3
  32. package/src/models/GetDashboardRequest.ts +9 -6
  33. package/src/models/GetDashboardResponseBody.ts +2 -2
  34. package/src/models/GetDashboardShrinkRequest.ts +9 -6
  35. package/src/models/GetHttpApiOperationResponseBody.ts +1 -1
  36. package/src/models/HttpApiDeployConfig.ts +3 -3
  37. package/src/models/ListHttpApisRequest.ts +9 -9
  38. package/src/models/QueryConsumerAuthorizationRulesRequest.ts +6 -6
  39. package/src/models/QueryConsumerAuthorizationRulesResponseBody.ts +8 -10
  40. package/src/models/UpdateHttpApiRequest.ts +16 -6
@@ -13,7 +13,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
13
13
  environmentId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The Ingress Class to listen on.
16
+ * The Ingress class to listen on.
17
17
  *
18
18
  * @example
19
19
  * mse
@@ -21,7 +21,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
21
21
  ingressClass?: string;
22
22
  /**
23
23
  * @remarks
24
- * Specifies whether to update the address in the Ingress Status.
24
+ * Specifies whether to update the address in the Ingress status.
25
25
  *
26
26
  * @example
27
27
  * false
@@ -87,7 +87,7 @@ export declare class UpdateHttpApiRequest extends $dara.Model {
87
87
  deployConfigs?: HttpApiDeployConfig[];
88
88
  /**
89
89
  * @remarks
90
- * The description of the API.
90
+ * The API description.
91
91
  *
92
92
  * @example
93
93
  * Update API description
@@ -116,7 +116,7 @@ export declare class UpdateHttpApiRequest extends $dara.Model {
116
116
  ingressConfig?: UpdateHttpApiRequestIngressConfig;
117
117
  /**
118
118
  * @remarks
119
- * Specifies whether to only modify the configuration. If set to true, only the configuration is modified without triggering a redeployment.
119
+ * Specifies whether to only modify the configuration. If this parameter is set to true, only the configuration is modified without triggering redeployment.
120
120
  *
121
121
  * @example
122
122
  * true
@@ -137,12 +137,20 @@ export declare class UpdateHttpApiRequest extends $dara.Model {
137
137
  removeBasePathOnForward?: boolean;
138
138
  /**
139
139
  * @remarks
140
- * The versioning configuration of the API.
140
+ * The API versioning configuration.
141
141
  */
142
142
  versionConfig?: HttpApiVersionConfig;
143
143
  /**
144
144
  * @remarks
145
- * Specifies whether to perform only a dry run. If set to true, all synchronous validations identical to a real update are performed without updating any configurations or producing side effects. If not specified or set to false, the behavior is the same as the existing version.
145
+ * The idempotent request identifier. If you call this operation for the same HTTP API with the same clientToken value and request parameters, the result of the first successful call is returned.
146
+ *
147
+ * @example
148
+ * update-http-api-client-token-001
149
+ */
150
+ clientToken?: string;
151
+ /**
152
+ * @remarks
153
+ * Specifies whether to perform only a dry run. If this parameter is set to true, all synchronous validations identical to an actual update are performed, but no configurations are updated 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.
146
154
  */
147
155
  dryRun?: boolean;
148
156
  static names(): {
@@ -82,6 +82,7 @@ class UpdateHttpApiRequest extends $dara.Model {
82
82
  protocols: 'protocols',
83
83
  removeBasePathOnForward: 'removeBasePathOnForward',
84
84
  versionConfig: 'versionConfig',
85
+ clientToken: 'clientToken',
85
86
  dryRun: 'dryRun',
86
87
  };
87
88
  }
@@ -100,6 +101,7 @@ class UpdateHttpApiRequest extends $dara.Model {
100
101
  protocols: { 'type': 'array', 'itemType': 'string' },
101
102
  removeBasePathOnForward: 'boolean',
102
103
  versionConfig: HttpApiVersionConfig_1.HttpApiVersionConfig,
104
+ clientToken: 'string',
103
105
  dryRun: 'boolean',
104
106
  };
105
107
  }
@@ -1 +1 @@
1
- {"version":3,"file":"UpdateHttpApiRequest.js","sourceRoot":"","sources":["../../src/models/UpdateHttpApiRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAC/C,6CAA0C;AAC1C,+DAA4D;AAC5D,iEAA8D;AAG9D,MAAa,iCAAkC,SAAQ,KAAK,CAAC,KAAK;IAyChE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,YAAY,EAAE,cAAc;YAC5B,iBAAiB,EAAE,mBAAmB;YACtC,QAAQ,EAAE,UAAU;YACpB,cAAc,EAAE,gBAAgB;SACjC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,SAAS;YAC5B,QAAQ,EAAE,QAAQ;YAClB,cAAc,EAAE,QAAQ;SACzB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AApED,8EAoEC;AAED,MAAa,oBAAqB,SAAQ,KAAK,CAAC,KAAK;IA2FnD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,gBAAgB;YAChC,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;YACxB,gBAAgB,EAAE,kBAAkB;YACpC,aAAa,EAAE,eAAe;YAC9B,gBAAgB,EAAE,kBAAkB;YACpC,SAAS,EAAE,WAAW;YACtB,uBAAuB,EAAE,yBAAyB;YAClD,aAAa,EAAE,eAAe;YAC9B,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACzD,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACtD,UAAU,EAAE,uBAAU;YACtB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,yCAAmB,EAAE;YACnE,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,SAAS;YACrB,gBAAgB,EAAE,QAAQ;YAC1B,aAAa,EAAE,iCAAiC;YAChD,gBAAgB,EAAE,SAAS;YAC3B,SAAS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACpD,uBAAuB,EAAE,SAAS;YAClC,aAAa,EAAE,2CAAoB;YACnC,MAAM,EAAE,SAAS;SAClB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjD,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC;QACD,IAAG,IAAI,CAAC,UAAU,IAAI,OAAQ,IAAI,CAAC,UAAkB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC7E,IAAI,CAAC,UAAkB,CAAC,QAAQ,EAAE,CAAC;QACtC,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACrC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;QACD,IAAG,IAAI,CAAC,aAAa,IAAI,OAAQ,IAAI,CAAC,aAAqB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnF,IAAI,CAAC,aAAqB,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QACD,IAAG,IAAI,CAAC,aAAa,IAAI,OAAQ,IAAI,CAAC,aAAqB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnF,IAAI,CAAC,aAAqB,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA7JD,oDA6JC"}
1
+ {"version":3,"file":"UpdateHttpApiRequest.js","sourceRoot":"","sources":["../../src/models/UpdateHttpApiRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAC/C,6CAA0C;AAC1C,+DAA4D;AAC5D,iEAA8D;AAG9D,MAAa,iCAAkC,SAAQ,KAAK,CAAC,KAAK;IAyChE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,YAAY,EAAE,cAAc;YAC5B,iBAAiB,EAAE,mBAAmB;YACtC,QAAQ,EAAE,UAAU;YACpB,cAAc,EAAE,gBAAgB;SACjC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,SAAS;YAC5B,QAAQ,EAAE,QAAQ;YAClB,cAAc,EAAE,QAAQ;SACzB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AApED,8EAoEC;AAED,MAAa,oBAAqB,SAAQ,KAAK,CAAC,KAAK;IAmGnD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,gBAAgB;YAChC,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;YACxB,gBAAgB,EAAE,kBAAkB;YACpC,aAAa,EAAE,eAAe;YAC9B,gBAAgB,EAAE,kBAAkB;YACpC,SAAS,EAAE,WAAW;YACtB,uBAAuB,EAAE,yBAAyB;YAClD,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACzD,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACtD,UAAU,EAAE,uBAAU;YACtB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,yCAAmB,EAAE;YACnE,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,SAAS;YACrB,gBAAgB,EAAE,QAAQ;YAC1B,aAAa,EAAE,iCAAiC;YAChD,gBAAgB,EAAE,SAAS;YAC3B,SAAS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACpD,uBAAuB,EAAE,SAAS;YAClC,aAAa,EAAE,2CAAoB;YACnC,WAAW,EAAE,QAAQ;YACrB,MAAM,EAAE,SAAS;SAClB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjD,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC;QACD,IAAG,IAAI,CAAC,UAAU,IAAI,OAAQ,IAAI,CAAC,UAAkB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC7E,IAAI,CAAC,UAAkB,CAAC,QAAQ,EAAE,CAAC;QACtC,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACrC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;QACD,IAAG,IAAI,CAAC,aAAa,IAAI,OAAQ,IAAI,CAAC,aAAqB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnF,IAAI,CAAC,aAAqB,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QACD,IAAG,IAAI,CAAC,aAAa,IAAI,OAAQ,IAAI,CAAC,aAAqB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnF,IAAI,CAAC,aAAqB,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAvKD,oDAuKC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alicloud/apig20240327",
3
- "version": "11.3.3",
3
+ "version": "11.3.5",
4
4
  "description": "",
5
5
  "main": "dist/client.js",
6
6
  "scripts": {
package/src/client.ts CHANGED
@@ -1327,6 +1327,11 @@ export default class Client extends OpenApi {
1327
1327
  */
1328
1328
  async createHttpApiWithOptions(request: $_model.CreateHttpApiRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateHttpApiResponse> {
1329
1329
  request.validate();
1330
+ let query : {[key: string ]: any} = { };
1331
+ if (!$dara.isNull(request.clientToken)) {
1332
+ query["clientToken"] = request.clientToken;
1333
+ }
1334
+
1330
1335
  let body : {[key: string ]: any} = { };
1331
1336
  if (!$dara.isNull(request.agentProtocols)) {
1332
1337
  body["agentProtocols"] = request.agentProtocols;
@@ -1406,6 +1411,7 @@ export default class Client extends OpenApi {
1406
1411
 
1407
1412
  let req = new $OpenApiUtil.OpenApiRequest({
1408
1413
  headers: headers,
1414
+ query: OpenApiUtil.query(query),
1409
1415
  body: OpenApiUtil.parseToMap(body),
1410
1416
  });
1411
1417
  let params = new $OpenApiUtil.Params({
@@ -1435,7 +1441,7 @@ export default class Client extends OpenApi {
1435
1441
  }
1436
1442
 
1437
1443
  /**
1438
- * Creates an operation for an HTTP API.
1444
+ * Creates operations for an HTTP API.
1439
1445
  *
1440
1446
  * @param request - CreateHttpApiOperationRequest
1441
1447
  * @param headers - map
@@ -1468,7 +1474,7 @@ export default class Client extends OpenApi {
1468
1474
  }
1469
1475
 
1470
1476
  /**
1471
- * Creates an operation for an HTTP API.
1477
+ * Creates operations for an HTTP API.
1472
1478
  *
1473
1479
  * @param request - CreateHttpApiOperationRequest
1474
1480
  * @returns CreateHttpApiOperationResponse
@@ -2686,7 +2692,7 @@ export default class Client extends OpenApi {
2686
2692
  * Deletes a quota throttling rule for a gateway.
2687
2693
  *
2688
2694
  * @remarks
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.
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.
2690
2696
  *
2691
2697
  * @param request - DeleteGatewayQuotaRuleRequest
2692
2698
  * @param headers - map
@@ -2716,7 +2722,7 @@ export default class Client extends OpenApi {
2716
2722
  * Deletes a quota throttling rule for a gateway.
2717
2723
  *
2718
2724
  * @remarks
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.
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.
2720
2726
  *
2721
2727
  * @param request - DeleteGatewayQuotaRuleRequest
2722
2728
  * @returns DeleteGatewayQuotaRuleResponse
@@ -4189,7 +4195,7 @@ export default class Client extends OpenApi {
4189
4195
  }
4190
4196
 
4191
4197
  /**
4192
- * Retrieves the API operation information.
4198
+ * Retrieves operation information.
4193
4199
  *
4194
4200
  * @param headers - map
4195
4201
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4214,7 +4220,7 @@ export default class Client extends OpenApi {
4214
4220
  }
4215
4221
 
4216
4222
  /**
4217
- * Retrieves the API operation information.
4223
+ * Retrieves operation information.
4218
4224
  * @returns GetHttpApiOperationResponse
4219
4225
  */
4220
4226
  async getHttpApiOperation(httpApiId: string, operationId: string): Promise<$_model.GetHttpApiOperationResponse> {
@@ -9505,6 +9511,10 @@ export default class Client extends OpenApi {
9505
9511
  async updateHttpApiWithOptions(httpApiId: string, request: $_model.UpdateHttpApiRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateHttpApiResponse> {
9506
9512
  request.validate();
9507
9513
  let query : {[key: string ]: any} = { };
9514
+ if (!$dara.isNull(request.clientToken)) {
9515
+ query["clientToken"] = request.clientToken;
9516
+ }
9517
+
9508
9518
  if (!$dara.isNull(request.dryRun)) {
9509
9519
  query["dryRun"] = request.dryRun;
9510
9520
  }
@@ -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. This field is not required for other types.
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. Required when type is LLM (only one protocol allowed) or Ai (multiple protocols allowed). Not required for other types. Example protocol: OpenAI/v1.
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. Required when enableAuth is set to true.
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 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 /.
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. Required when type is LLM or Ai (only one deployment configuration allowed). Not validated at the request level for other types.
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 description.
129
+ * The description of the API.
130
130
  *
131
131
  * @example
132
132
  * Test API for integration
@@ -134,7 +134,7 @@ export class CreateHttpApiRequest extends $dara.Model {
134
134
  description?: string;
135
135
  /**
136
136
  * @remarks
137
- * Specifies whether to preview only without executing.
137
+ * Specifies whether to perform a dry run without executing the operation.
138
138
  *
139
139
  * @example
140
140
  * true
@@ -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. Validated when type is LLM, Ai, or Agent. Not validated at the request level when type is Rest.
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
@@ -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 backend to return the first byte.
155
+ * The timeout period for waiting for the first byte from the backend.
156
156
  *
157
157
  * @example
158
158
  * 30
@@ -160,20 +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 null. Not required for other types.
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. Optional when type is LLM or Ai. Not required for other types. Valid values:
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
169
  * - Text: text generation.
170
170
  * - Image: image generation.
171
171
  * - Audio: audio processing.
172
- * - Video: video generation.
172
+ * - Video: AI video generation.
173
173
  * - MultiModal: multimodal.
174
- * - Embedding: vector embedding.
174
+ * - Embedding: embedding.
175
175
  * - Rerank: reranking.
176
- * - Others: others.
176
+ * - Others: other.
177
177
  *
178
178
  * @example
179
179
  * Text
@@ -181,7 +181,7 @@ export class CreateHttpApiRequest extends $dara.Model {
181
181
  modelCategory?: string;
182
182
  /**
183
183
  * @remarks
184
- * The name of the HTTP API, used to identify the current API resource. For example, test-api.
184
+ * The name of the HTTP API, which identifies the API resource. Example: test-api.
185
185
  *
186
186
  * This parameter is required.
187
187
  *
@@ -212,7 +212,7 @@ export class CreateHttpApiRequest extends $dara.Model {
212
212
  resourceGroupId?: string;
213
213
  /**
214
214
  * @remarks
215
- * The conflict resolution strategy for imports.
215
+ * The conflict merge strategy for import.
216
216
  *
217
217
  * @example
218
218
  * ExistFirst
@@ -226,7 +226,7 @@ export class CreateHttpApiRequest extends $dara.Model {
226
226
  * - WebSocket: a WebSocket API.
227
227
  * - HttpIngress: an HTTP API accessed through Ingress.
228
228
  * - LLM: a large language model API.
229
- * - Agent: an Agent proxy API.
229
+ * - Agent: an agent proxy API.
230
230
  *
231
231
  * This parameter is required.
232
232
  *
@@ -239,6 +239,14 @@ export class CreateHttpApiRequest extends $dara.Model {
239
239
  * The API versioning configuration.
240
240
  */
241
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;
242
250
  static names(): { [key: string]: string } {
243
251
  return {
244
252
  agentProtocols: 'agentProtocols',
@@ -260,6 +268,7 @@ export class CreateHttpApiRequest extends $dara.Model {
260
268
  strategy: 'strategy',
261
269
  type: 'type',
262
270
  versionConfig: 'versionConfig',
271
+ clientToken: 'clientToken',
263
272
  };
264
273
  }
265
274
 
@@ -284,6 +293,7 @@ export class CreateHttpApiRequest extends $dara.Model {
284
293
  strategy: 'string',
285
294
  type: 'string',
286
295
  versionConfig: HttpApiVersionConfig,
296
+ clientToken: 'string',
287
297
  };
288
298
  }
289
299
 
@@ -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 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.
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
@@ -49,7 +49,7 @@ export class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model
49
49
  port?: number;
50
50
  /**
51
51
  * @remarks
52
- * The service protocol. Valid values:
52
+ * The Terms of Service. Valid values:
53
53
  * - HTTP.
54
54
  * - HTTPS.
55
55
  *
@@ -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 takes effect only in the tag-based scenario.
78
+ * The service version. This parameter takes effect only in tag-based scenarios.
79
79
  *
80
80
  * @example
81
81
  * v1
@@ -194,7 +194,7 @@ export class CreateHttpApiRouteRequestMcpRouteConfig extends $dara.Model {
194
194
  mcpStatisticsEnable?: boolean;
195
195
  /**
196
196
  * @remarks
197
- * The service protocol. Valid values:
197
+ * The Terms of Service. Valid values:
198
198
  * - TCP.
199
199
  * - HTTP.
200
200
  * - DUBBO.
@@ -16,6 +16,8 @@ export class CreateMigrationTaskRequest extends $dara.Model {
16
16
  /**
17
17
  * @example
18
18
  * env-xxxx
19
+ *
20
+ * @deprecated
19
21
  */
20
22
  environmentId?: string;
21
23
  /**
@@ -51,9 +51,8 @@ export class GetConsumerAuthorizationRuleResponseBody extends $dara.Model {
51
51
  /**
52
52
  * @remarks
53
53
  * The expiration mode. Valid values:
54
- *
55
- * - LongTerm
56
- * - ShortTerm
54
+ * - LongTerm: long-term
55
+ * - ShortTerm: short-term
57
56
  *
58
57
  * @example
59
58
  * LongTerm
@@ -35,9 +35,10 @@ export class GetDashboardRequestFilter extends $dara.Model {
35
35
  export class GetDashboardRequest extends $dara.Model {
36
36
  /**
37
37
  * @remarks
38
- * The response language. Valid values:
39
- * zh: Chinese
40
- * en: English
38
+ * The language. Valid values:
39
+ *
40
+ * - zh: Chinese
41
+ * - en: English
41
42
  *
42
43
  * @example
43
44
  * zh
@@ -59,8 +60,9 @@ export class GetDashboardRequest extends $dara.Model {
59
60
  /**
60
61
  * @remarks
61
62
  * The dashboard name. Valid values:
63
+ *
62
64
  * - LOG: access log
63
- * - PLUGIN: plug-in log
65
+ * - PLUGIN: plugin log
64
66
  *
65
67
  * @example
66
68
  * PLUGIN
@@ -68,7 +70,7 @@ export class GetDashboardRequest extends $dara.Model {
68
70
  name?: string;
69
71
  /**
70
72
  * @remarks
71
- * The plug-in type ID.
73
+ * The plugin type ID.
72
74
  *
73
75
  * @example
74
76
  * pls-dn82a9djd8z****
@@ -76,7 +78,7 @@ export class GetDashboardRequest extends $dara.Model {
76
78
  pluginClassId?: string;
77
79
  /**
78
80
  * @remarks
79
- * The plug-in ID.
81
+ * The plugin ID.
80
82
  *
81
83
  * @example
82
84
  * inner-ai-search-cvd3mcum1hks660icn10
@@ -93,6 +95,7 @@ export class GetDashboardRequest extends $dara.Model {
93
95
  /**
94
96
  * @remarks
95
97
  * The dashboard source. Valid values:
98
+ *
96
99
  * - SLS: log dashboard
97
100
  *
98
101
  * @example
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetDashboardResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The unique identifier of the gateway.
8
+ * The unique ID of the gateway.
9
9
  *
10
10
  * @example
11
11
  * gw-co370icmjeu****
@@ -29,7 +29,7 @@ export class GetDashboardResponseBodyData extends $dara.Model {
29
29
  title?: string;
30
30
  /**
31
31
  * @remarks
32
- * The dashboard URL.
32
+ * The URL of the dashboard.
33
33
  *
34
34
  * @example
35
35
  * https://sls.console.aliyun.com/lognext/project/xxxxx
@@ -5,9 +5,10 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetDashboardShrinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The response language. Valid values:
9
- * zh: Chinese
10
- * en: English
8
+ * The language. Valid values:
9
+ *
10
+ * - zh: Chinese
11
+ * - en: English
11
12
  *
12
13
  * @example
13
14
  * zh
@@ -29,8 +30,9 @@ export class GetDashboardShrinkRequest extends $dara.Model {
29
30
  /**
30
31
  * @remarks
31
32
  * The dashboard name. Valid values:
33
+ *
32
34
  * - LOG: access log
33
- * - PLUGIN: plug-in log
35
+ * - PLUGIN: plugin log
34
36
  *
35
37
  * @example
36
38
  * PLUGIN
@@ -38,7 +40,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
38
40
  name?: string;
39
41
  /**
40
42
  * @remarks
41
- * The plug-in type ID.
43
+ * The plugin type ID.
42
44
  *
43
45
  * @example
44
46
  * pls-dn82a9djd8z****
@@ -46,7 +48,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
46
48
  pluginClassId?: string;
47
49
  /**
48
50
  * @remarks
49
- * The plug-in ID.
51
+ * The plugin ID.
50
52
  *
51
53
  * @example
52
54
  * inner-ai-search-cvd3mcum1hks660icn10
@@ -63,6 +65,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
63
65
  /**
64
66
  * @remarks
65
67
  * The dashboard source. Valid values:
68
+ *
66
69
  * - SLS: log dashboard
67
70
  *
68
71
  * @example
@@ -14,7 +14,7 @@ export class GetHttpApiOperationResponseBody extends $dara.Model {
14
14
  code?: string;
15
15
  /**
16
16
  * @remarks
17
- * The API operation information.
17
+ * The operation information.
18
18
  */
19
19
  data?: HttpApiOperationInfo;
20
20
  /**
@@ -160,7 +160,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
160
160
  export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
161
161
  /**
162
162
  * @remarks
163
- * The capability tier of the intelligent routing candidate. Specify this parameter only when the publishing scenario is AiAutoRouter. Valid values: economy, standard, and premium.
163
+ * The capability tier for intelligent routing candidates. Specify this parameter only when the publishing scenario is AiAutoRouter. Valid values: economy, standard, and premium.
164
164
  *
165
165
  * @example
166
166
  * standard
@@ -498,12 +498,12 @@ export class HttpApiDeployConfig extends $dara.Model {
498
498
  serviceConfigs?: HttpApiDeployConfigServiceConfigs[];
499
499
  /**
500
500
  * @remarks
501
- * The list of subdomain content.
501
+ * The list of second-level domain name content.
502
502
  */
503
503
  subDomains?: HttpApiDeployConfigSubDomains[];
504
504
  /**
505
505
  * @remarks
506
- * The set of explicitly enabled gateway system model capability tiers. Takes effect only when the publishing scenario is AiAutoRouter. Valid values: economy, standard, premium. An explicit empty array indicates that no system model is enabled.
506
+ * The set of explicitly enabled gateway system model capability tiers. Takes effect only when the publishing scenario is AiAutoRouter. Valid values: economy, standard, and premium. An explicitly empty array indicates that no system models are enabled.
507
507
  *
508
508
  * @example
509
509
  * ["economy","standard","premium"]
@@ -13,7 +13,7 @@ export class ListHttpApisRequest extends $dara.Model {
13
13
  gatewayId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The gateway type associated with the HTTP API. Valid values:
16
+ * The type of gateway associated with the HTTP API. Valid values:
17
17
  * - API: cloud-native API gateway.
18
18
  * - AI: AI gateway.
19
19
  *
@@ -31,7 +31,7 @@ export class ListHttpApisRequest extends $dara.Model {
31
31
  keyword?: string;
32
32
  /**
33
33
  * @remarks
34
- * Searches by exact name match.
34
+ * Searches for an HTTP API by exact name match.
35
35
  *
36
36
  * @example
37
37
  * login
@@ -47,7 +47,7 @@ export class ListHttpApisRequest extends $dara.Model {
47
47
  pageNumber?: number;
48
48
  /**
49
49
  * @remarks
50
- * The page size. Valid range: [1, 100]. Default value: 10.
50
+ * The page size. Valid values: 1 to 100. Default value: 10.
51
51
  *
52
52
  * @example
53
53
  * 10
@@ -55,7 +55,7 @@ export class ListHttpApisRequest extends $dara.Model {
55
55
  pageSize?: number;
56
56
  /**
57
57
  * @remarks
58
- * The resource group ID.
58
+ * The ID of the resource group.
59
59
  *
60
60
  * @example
61
61
  * rg-ahr5uil8raz0rq3b
@@ -75,7 +75,7 @@ export class ListHttpApisRequest extends $dara.Model {
75
75
  types?: string;
76
76
  /**
77
77
  * @remarks
78
- * Specifies whether to return API information that has been published to the specified environment.
78
+ * Specifies whether to return information about APIs published to the specified environment.
79
79
  *
80
80
  * @example
81
81
  * true
@@ -83,7 +83,7 @@ export class ListHttpApisRequest extends $dara.Model {
83
83
  withAPIsPublishedToEnvironment?: boolean;
84
84
  /**
85
85
  * @remarks
86
- * Specifies the environment ID. The response includes consumer authentication policy information for each API in the specified environment.
86
+ * The environment ID. If specified, the response includes consumer authentication policy information for each API in the specified environment.
87
87
  *
88
88
  * @example
89
89
  * env-xxx
@@ -91,7 +91,7 @@ export class ListHttpApisRequest extends $dara.Model {
91
91
  withAuthPolicyInEnvironmentId?: string;
92
92
  /**
93
93
  * @remarks
94
- * Specifies whether permission authentication policies are enabled.
94
+ * Specifies whether the permission authentication policy is enabled.
95
95
  *
96
96
  * @example
97
97
  * true
@@ -99,7 +99,7 @@ export class ListHttpApisRequest extends $dara.Model {
99
99
  withAuthPolicyList?: boolean;
100
100
  /**
101
101
  * @remarks
102
- * Specifies the consumer ID. The response includes the authorization rule list for the specified consumer for each API.
102
+ * The consumer ID. If specified, the response includes the authorization rule list for the specified consumer for each API.
103
103
  *
104
104
  * @example
105
105
  * cs-xxx
@@ -131,7 +131,7 @@ export class ListHttpApisRequest extends $dara.Model {
131
131
  withIngressInfo?: boolean;
132
132
  /**
133
133
  * @remarks
134
- * The plug-in ID. Used to retrieve plug-in publishing information based on this plug-in ID.
134
+ * The plug-in ID. If specified, the response includes plug-in publishing information for the specified plug-in.
135
135
  *
136
136
  * @example
137
137
  * pl-ct9qn3um1hktue8dqol0