@alicloud/apig20240327 3.2.0 → 3.2.2

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 (5) hide show
  1. package/dist/client.d.ts +534 -431
  2. package/dist/client.js +63 -40
  3. package/dist/client.js.map +1 -1
  4. package/package.json +1 -1
  5. package/src/client.ts +568 -431
package/src/client.ts CHANGED
@@ -1887,7 +1887,7 @@ export class TlsCipherSuitesConfigTlsCipherSuite extends $dara.Model {
1887
1887
  export class CreateDomainResponseBodyData extends $dara.Model {
1888
1888
  /**
1889
1889
  * @remarks
1890
- * Domain ID.
1890
+ * The ID of the domain name.
1891
1891
  *
1892
1892
  * @example
1893
1893
  * d-cpu1aullhtgkidg7sa4g
@@ -1947,7 +1947,7 @@ export class CreateEnvironmentResponseBodyData extends $dara.Model {
1947
1947
  export class CreateHttpApiRequestIngressConfig extends $dara.Model {
1948
1948
  /**
1949
1949
  * @remarks
1950
- * Environment ID.
1950
+ * The environment ID.
1951
1951
  *
1952
1952
  * @example
1953
1953
  * env-cq146allhtgk***
@@ -1955,7 +1955,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
1955
1955
  environmentId?: string;
1956
1956
  /**
1957
1957
  * @remarks
1958
- * Ingress Class being listened to.
1958
+ * The Ingress Class for listening.
1959
1959
  *
1960
1960
  * @example
1961
1961
  * mse
@@ -1963,7 +1963,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
1963
1963
  ingressClass?: string;
1964
1964
  /**
1965
1965
  * @remarks
1966
- * Whether to update the address in the Ingress Status.
1966
+ * Specifies whether to update the address in Ingress Status.
1967
1967
  *
1968
1968
  * @example
1969
1969
  * false
@@ -1971,7 +1971,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
1971
1971
  overrideIngressIp?: boolean;
1972
1972
  /**
1973
1973
  * @remarks
1974
- * Source ID.
1974
+ * The source ID.
1975
1975
  *
1976
1976
  * @example
1977
1977
  * src-crdddallhtgtr***
@@ -1979,7 +1979,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
1979
1979
  sourceId?: string;
1980
1980
  /**
1981
1981
  * @remarks
1982
- * Namespace being watched.
1982
+ * The namespace for listening.
1983
1983
  *
1984
1984
  * @example
1985
1985
  * default
@@ -2017,7 +2017,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
2017
2017
  export class CreateHttpApiResponseBodyData extends $dara.Model {
2018
2018
  /**
2019
2019
  * @remarks
2020
- * HTTP API ID.
2020
+ * The HTTP API ID.
2021
2021
  *
2022
2022
  * @example
2023
2023
  * api-xxx
@@ -2025,7 +2025,7 @@ export class CreateHttpApiResponseBodyData extends $dara.Model {
2025
2025
  httpApiId?: string;
2026
2026
  /**
2027
2027
  * @remarks
2028
- * Name of the API.
2028
+ * The API name.
2029
2029
  *
2030
2030
  * @example
2031
2031
  * test-api
@@ -2325,23 +2325,22 @@ export class CreatePolicyAttachmentResponseBodyData extends $dara.Model {
2325
2325
  export class CreateServiceRequestServiceConfigs extends $dara.Model {
2326
2326
  /**
2327
2327
  * @remarks
2328
- * List of domain names or fixed addresses.
2328
+ * The list of domain names or fixed addresses.
2329
2329
  */
2330
2330
  addresses?: string[];
2331
2331
  /**
2332
2332
  * @remarks
2333
- * AI service configuration.
2333
+ * The AI service configurations.
2334
2334
  */
2335
2335
  aiServiceConfig?: AiServiceConfig;
2336
2336
  /**
2337
2337
  * @remarks
2338
- * List of DNS server addresses.
2338
+ * The list of DNS service addresses.
2339
2339
  */
2340
2340
  dnsServers?: string[];
2341
2341
  /**
2342
2342
  * @remarks
2343
- * Service group name.
2344
- * Needs to be specified when `sourceType` is MSE_NACOS.
2343
+ * The service group name. This parameter is required if sourceType is set to MSE_NACOS.
2345
2344
  *
2346
2345
  * @example
2347
2346
  * DEFAULT_GROUP
@@ -2349,7 +2348,7 @@ export class CreateServiceRequestServiceConfigs extends $dara.Model {
2349
2348
  groupName?: string;
2350
2349
  /**
2351
2350
  * @remarks
2352
- * Service name.
2351
+ * The service name.
2353
2352
  *
2354
2353
  * @example
2355
2354
  * user-service
@@ -2357,12 +2356,10 @@ export class CreateServiceRequestServiceConfigs extends $dara.Model {
2357
2356
  name?: string;
2358
2357
  /**
2359
2358
  * @remarks
2360
- * Namespace of the service:
2359
+ * The service namespace. This parameter is required when sourceType is set to K8S or MSE_NACOS.
2361
2360
  *
2362
- * - When `sourceType` is K8S, it represents the namespace where the K8S service is located.
2363
- * - When `sourceType` is MSE_NACOS, it represents the namespace in Nacos.
2364
- *
2365
- * It needs to be specified when `sourceType` is K8S or MSE_NACOS.
2361
+ * * If sourceType is set to K8S, this parameter specifies the namespace where the K8s service resides.
2362
+ * * If sourceType is set to MSE_NACOS, this parameter specifies a namespace in Nacos.
2366
2363
  *
2367
2364
  * @example
2368
2365
  * PUBLIC
@@ -2370,7 +2367,7 @@ export class CreateServiceRequestServiceConfigs extends $dara.Model {
2370
2367
  namespace?: string;
2371
2368
  /**
2372
2369
  * @remarks
2373
- * Function version or alias.
2370
+ * The function version or alias.
2374
2371
  *
2375
2372
  * @example
2376
2373
  * LATEST
@@ -2421,7 +2418,7 @@ export class CreateServiceRequestServiceConfigs extends $dara.Model {
2421
2418
  export class CreateServiceResponseBodyData extends $dara.Model {
2422
2419
  /**
2423
2420
  * @remarks
2424
- * List of service IDs.
2421
+ * The list of service IDs.
2425
2422
  */
2426
2423
  serviceIds?: string[];
2427
2424
  static names(): { [key: string]: string } {
@@ -2673,7 +2670,7 @@ export class ExportHttpApiResponseBodyData extends $dara.Model {
2673
2670
  export class GetDashboardRequestFilter extends $dara.Model {
2674
2671
  /**
2675
2672
  * @remarks
2676
- * Route name
2673
+ * The route name.
2677
2674
  *
2678
2675
  * @example
2679
2676
  * test-route
@@ -2703,7 +2700,7 @@ export class GetDashboardRequestFilter extends $dara.Model {
2703
2700
  export class GetDashboardResponseBodyData extends $dara.Model {
2704
2701
  /**
2705
2702
  * @remarks
2706
- * Gateway unique identifier
2703
+ * The instance ID.
2707
2704
  *
2708
2705
  * @example
2709
2706
  * gw-co370icmjeu****
@@ -2711,7 +2708,7 @@ export class GetDashboardResponseBodyData extends $dara.Model {
2711
2708
  gatewayId?: string;
2712
2709
  /**
2713
2710
  * @remarks
2714
- * Dashboard name
2711
+ * The dashboard name.
2715
2712
  *
2716
2713
  * @example
2717
2714
  * PLUGIN
@@ -2719,7 +2716,7 @@ export class GetDashboardResponseBodyData extends $dara.Model {
2719
2716
  name?: string;
2720
2717
  /**
2721
2718
  * @remarks
2722
- * Dashboard title
2719
+ * The dashboard title.
2723
2720
  *
2724
2721
  * @example
2725
2722
  * APIG Plugin
@@ -2727,7 +2724,7 @@ export class GetDashboardResponseBodyData extends $dara.Model {
2727
2724
  title?: string;
2728
2725
  /**
2729
2726
  * @remarks
2730
- * Dashboard URL link
2727
+ * The dashboard URL.
2731
2728
  *
2732
2729
  * @example
2733
2730
  * https://sls.console.aliyun.com/lognext/project/xxxxx
@@ -2763,12 +2760,12 @@ export class GetDashboardResponseBodyData extends $dara.Model {
2763
2760
  export class GetDomainResponseBodyDataStatisticsInfo extends $dara.Model {
2764
2761
  /**
2765
2762
  * @remarks
2766
- * The array of related resource infomations.
2763
+ * The resource statistics.
2767
2764
  */
2768
2765
  resourceStatistics?: ResourceStatistic[];
2769
2766
  /**
2770
2767
  * @remarks
2771
- * The total number of entries returned.
2768
+ * The total number of resources.
2772
2769
  *
2773
2770
  * @example
2774
2771
  * 1
@@ -2803,7 +2800,7 @@ export class GetDomainResponseBodyDataStatisticsInfo extends $dara.Model {
2803
2800
  export class GetDomainResponseBodyData extends $dara.Model {
2804
2801
  /**
2805
2802
  * @remarks
2806
- * Encryption algorithm name
2803
+ * The encryption algorithm.
2807
2804
  *
2808
2805
  * @example
2809
2806
  * RSA
@@ -2811,7 +2808,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2811
2808
  algorithm?: string;
2812
2809
  /**
2813
2810
  * @remarks
2814
- * CA certificate identifier
2811
+ * The CA certificate ID.
2815
2812
  *
2816
2813
  * @example
2817
2814
  * 876****-cn-hangzhou
@@ -2819,7 +2816,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2819
2816
  caCertIdentifier?: string;
2820
2817
  /**
2821
2818
  * @remarks
2822
- * Certificate Identifier
2819
+ * The certificate ID.
2823
2820
  *
2824
2821
  * @example
2825
2822
  * 645****-cn-hangzhou
@@ -2827,7 +2824,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2827
2824
  certIdentifier?: string;
2828
2825
  /**
2829
2826
  * @remarks
2830
- * Certificate name
2827
+ * The certificate name.
2831
2828
  *
2832
2829
  * @example
2833
2830
  * test-cert
@@ -2835,7 +2832,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2835
2832
  certName?: string;
2836
2833
  /**
2837
2834
  * @remarks
2838
- * Client CA Cert
2835
+ * The client CA certificate.
2839
2836
  *
2840
2837
  * @example
2841
2838
  * -----BEGIN CERTIFICATE-----
@@ -2850,7 +2847,12 @@ export class GetDomainResponseBodyData extends $dara.Model {
2850
2847
  clientCACert?: string;
2851
2848
  /**
2852
2849
  * @remarks
2853
- * Where it was created from.
2850
+ * The creation source.
2851
+ *
2852
+ * Valid values:
2853
+ *
2854
+ * * Console
2855
+ * * Ingress
2854
2856
  *
2855
2857
  * @example
2856
2858
  * Console
@@ -2858,7 +2860,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2858
2860
  createFrom?: string;
2859
2861
  /**
2860
2862
  * @remarks
2861
- * Creation timestamp.
2863
+ * The creation timestamp.
2862
2864
  *
2863
2865
  * @example
2864
2866
  * 1719386834548
@@ -2866,7 +2868,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2866
2868
  createTimestamp?: number;
2867
2869
  /**
2868
2870
  * @remarks
2869
- * Whether it is the default domain.
2871
+ * Indicates whether the domain name is the default domain name.
2870
2872
  *
2871
2873
  * @example
2872
2874
  * false
@@ -2874,7 +2876,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2874
2876
  default?: boolean;
2875
2877
  /**
2876
2878
  * @remarks
2877
- * Domain ID.
2879
+ * The ID of the domain name.
2878
2880
  *
2879
2881
  * @example
2880
2882
  * d-cq1m3utlhtgvgkv7sitg
@@ -2882,7 +2884,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2882
2884
  domainId?: string;
2883
2885
  /**
2884
2886
  * @remarks
2885
- * Setting for HTTPS protocol type, whether to enable forced HTTPS redirection.
2887
+ * Indicates whether forcible HTTPS redirection is enabled.
2886
2888
  *
2887
2889
  * @example
2888
2890
  * false
@@ -2890,7 +2892,13 @@ export class GetDomainResponseBodyData extends $dara.Model {
2890
2892
  forceHttps?: boolean;
2891
2893
  /**
2892
2894
  * @remarks
2893
- * HTTP/2 setting.
2895
+ * The HTTP/2 configuration.
2896
+ *
2897
+ * Valid values:
2898
+ *
2899
+ * * GlobalConfig
2900
+ * * Close
2901
+ * * Open
2894
2902
  *
2895
2903
  * @example
2896
2904
  * Open
@@ -2898,7 +2906,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2898
2906
  http2Option?: string;
2899
2907
  /**
2900
2908
  * @remarks
2901
- * Certificate issuer.
2909
+ * The certificate issuer.
2902
2910
  *
2903
2911
  * @example
2904
2912
  * Alibaba
@@ -2906,7 +2914,12 @@ export class GetDomainResponseBodyData extends $dara.Model {
2906
2914
  issuer?: string;
2907
2915
  /**
2908
2916
  * @remarks
2909
- * true
2917
+ * Indicates whether mutual authentication is enabled.
2918
+ *
2919
+ * Valid values:
2920
+ *
2921
+ * * false
2922
+ * * true
2910
2923
  *
2911
2924
  * @example
2912
2925
  * false
@@ -2914,7 +2927,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2914
2927
  mTLSEnabled?: boolean;
2915
2928
  /**
2916
2929
  * @remarks
2917
- * Domain name.
2930
+ * The domain name.
2918
2931
  *
2919
2932
  * @example
2920
2933
  * abc.com
@@ -2922,7 +2935,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2922
2935
  name?: string;
2923
2936
  /**
2924
2937
  * @remarks
2925
- * Certificate expiration time.
2938
+ * The expiration time of the certificate.
2926
2939
  *
2927
2940
  * @example
2928
2941
  * 1719386834548
@@ -2930,7 +2943,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2930
2943
  notAfterTimstamp?: number;
2931
2944
  /**
2932
2945
  * @remarks
2933
- * Certificate effective time.
2946
+ * The time when the certificate started to take effect.
2934
2947
  *
2935
2948
  * @example
2936
2949
  * 1719386834548
@@ -2938,10 +2951,10 @@ export class GetDomainResponseBodyData extends $dara.Model {
2938
2951
  notBeforeTimestamp?: number;
2939
2952
  /**
2940
2953
  * @remarks
2941
- * The protocol types supported by the domain.
2954
+ * The supported protocol. Valid values:
2942
2955
  *
2943
- * - HTTP: Supports only HTTP protocol.
2944
- * - HTTPS: Supports only HTTPS protocol.
2956
+ * * HTTP: Only HTTP is supported.
2957
+ * * HTTPS: Only HTTPS is supported.
2945
2958
  *
2946
2959
  * @example
2947
2960
  * HTTP
@@ -2949,7 +2962,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2949
2962
  protocol?: string;
2950
2963
  /**
2951
2964
  * @remarks
2952
- * The ID of the resource group.
2965
+ * The resource group ID.
2953
2966
  *
2954
2967
  * @example
2955
2968
  * rg-aekzvlxzgo5b4si
@@ -2957,7 +2970,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2957
2970
  resourceGroupId?: string;
2958
2971
  /**
2959
2972
  * @remarks
2960
- * All domain names bound to the certificate.
2973
+ * All domain names that are bound to the certificate.
2961
2974
  *
2962
2975
  * @example
2963
2976
  * aliyun.com
@@ -2965,17 +2978,17 @@ export class GetDomainResponseBodyData extends $dara.Model {
2965
2978
  sans?: string;
2966
2979
  /**
2967
2980
  * @remarks
2968
- * The array of domain related resource information
2981
+ * The information about online resources.
2969
2982
  */
2970
2983
  statisticsInfo?: GetDomainResponseBodyDataStatisticsInfo;
2971
2984
  /**
2972
2985
  * @remarks
2973
- * The TLS cipher suites config.
2986
+ * The cipher suite configuration.
2974
2987
  */
2975
2988
  tlsCipherSuitesConfig?: TlsCipherSuitesConfig;
2976
2989
  /**
2977
2990
  * @remarks
2978
- * Maximum TLS protocol version, supports up to TLS 1.3.
2991
+ * The maximum version of the TLS protocol. Up to TLS 1.3 is supported.
2979
2992
  *
2980
2993
  * @example
2981
2994
  * TLS 1.3
@@ -2983,7 +2996,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2983
2996
  tlsMax?: string;
2984
2997
  /**
2985
2998
  * @remarks
2986
- * Minimum TLS protocol version, supports down to TLS 1.0.
2999
+ * The minimum version of the TLS protocol. Down to TLS 1.0 is supported.
2987
3000
  *
2988
3001
  * @example
2989
3002
  * TLS 1.0
@@ -2991,7 +3004,7 @@ export class GetDomainResponseBodyData extends $dara.Model {
2991
3004
  tlsMin?: string;
2992
3005
  /**
2993
3006
  * @remarks
2994
- * Update timestamp.
3007
+ * The update timestamp.
2995
3008
  *
2996
3009
  * @example
2997
3010
  * 1719386834548
@@ -4223,7 +4236,7 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
4223
4236
  export class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
4224
4237
  /**
4225
4238
  * @remarks
4226
- * The name of the Object Storage Service (OSS) bucket that stores the dictionary file.
4239
+ * The bucket name.
4227
4240
  *
4228
4241
  * @example
4229
4242
  * api-1
@@ -4231,7 +4244,7 @@ export class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
4231
4244
  bucketName?: string;
4232
4245
  /**
4233
4246
  * @remarks
4234
- * The file path.
4247
+ * The full path of the file.
4235
4248
  *
4236
4249
  * @example
4237
4250
  * /test/swagger.json
@@ -4273,15 +4286,15 @@ export class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
4273
4286
  export class ImportHttpApiResponseBodyDataDryRunInfoFailureComponents extends $dara.Model {
4274
4287
  /**
4275
4288
  * @remarks
4276
- * Error message.
4289
+ * The error message.
4277
4290
  *
4278
4291
  * @example
4279
- * 数据结构定义有误。
4292
+ * The data struct is incorrectly defined.
4280
4293
  */
4281
4294
  errorMessage?: string;
4282
4295
  /**
4283
4296
  * @remarks
4284
- * 数据结构名称。
4297
+ * The data struct name.
4285
4298
  *
4286
4299
  * @example
4287
4300
  * orderDTO
@@ -4313,15 +4326,15 @@ export class ImportHttpApiResponseBodyDataDryRunInfoFailureComponents extends $d
4313
4326
  export class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations extends $dara.Model {
4314
4327
  /**
4315
4328
  * @remarks
4316
- * Error message
4329
+ * The error message.
4317
4330
  *
4318
4331
  * @example
4319
- * 缺少响应定义。
4332
+ * Missing response definition.
4320
4333
  */
4321
4334
  errorMessage?: string;
4322
4335
  /**
4323
4336
  * @remarks
4324
- * API method.
4337
+ * The HTTP method of the operation.
4325
4338
  *
4326
4339
  * @example
4327
4340
  * GET
@@ -4329,7 +4342,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations extends $d
4329
4342
  method?: string;
4330
4343
  /**
4331
4344
  * @remarks
4332
- * API path.
4345
+ * The operation path.
4333
4346
  *
4334
4347
  * @example
4335
4348
  * /v1/orders
@@ -4363,9 +4376,10 @@ export class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations extends $d
4363
4376
  export class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents extends $dara.Model {
4364
4377
  /**
4365
4378
  * @remarks
4366
- * Action to be executed after the precheck.
4367
- * - Create: Create
4368
- * - Update: Update
4379
+ * The action that will be performed for the data struct after the dry run.
4380
+ *
4381
+ * * Create: The data struct is created.
4382
+ * * Update: The data struct is updated.
4369
4383
  *
4370
4384
  * @example
4371
4385
  * Create
@@ -4373,7 +4387,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents extends $d
4373
4387
  action?: string;
4374
4388
  /**
4375
4389
  * @remarks
4376
- * Data structure name.
4390
+ * The data struct name.
4377
4391
  *
4378
4392
  * @example
4379
4393
  * userDTO
@@ -4405,9 +4419,10 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents extends $d
4405
4419
  export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $dara.Model {
4406
4420
  /**
4407
4421
  * @remarks
4408
- * Action to be executed after the precheck.
4409
- * - Create: Create
4410
- * - Update: Update
4422
+ * The action that will be performed for the operation after the dry run.
4423
+ *
4424
+ * * Create: The operation is created.
4425
+ * * Update: The operation is updated.
4411
4426
  *
4412
4427
  * @example
4413
4428
  * Create
@@ -4415,7 +4430,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
4415
4430
  action?: string;
4416
4431
  /**
4417
4432
  * @remarks
4418
- * API method.
4433
+ * The HTTP method of the operation.
4419
4434
  *
4420
4435
  * @example
4421
4436
  * POST
@@ -4423,7 +4438,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
4423
4438
  method?: string;
4424
4439
  /**
4425
4440
  * @remarks
4426
- * API name.
4441
+ * The operation name.
4427
4442
  *
4428
4443
  * @example
4429
4444
  * CreateUser
@@ -4431,7 +4446,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
4431
4446
  name?: string;
4432
4447
  /**
4433
4448
  * @remarks
4434
- * API path.
4449
+ * The operation path.
4435
4450
  *
4436
4451
  * @example
4437
4452
  * /v1/users
@@ -4467,37 +4482,37 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
4467
4482
  export class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
4468
4483
  /**
4469
4484
  * @remarks
4470
- * Error messages. If there are any error messages, the API cannot be imported successfully.
4485
+ * The error messages. If an error message is returned, the API fails to be imported.
4471
4486
  */
4472
4487
  errorMessages?: string[];
4473
4488
  /**
4474
4489
  * @remarks
4475
- * 已存在的API信息。若该字段非空，则导入动作将更新该API。
4490
+ * The existing APIs. If an existing API is returned, the import updates the existing API.
4476
4491
  */
4477
4492
  existHttpApiInfo?: HttpApiApiInfo;
4478
4493
  /**
4479
4494
  * @remarks
4480
- * List of data structures that failed the precheck.
4495
+ * The data structs that fail the dry run.
4481
4496
  */
4482
4497
  failureComponents?: ImportHttpApiResponseBodyDataDryRunInfoFailureComponents[];
4483
4498
  /**
4484
4499
  * @remarks
4485
- * List of APIs that failed the precheck.
4500
+ * The operations that fail the dry run.
4486
4501
  */
4487
4502
  failureOperations?: ImportHttpApiResponseBodyDataDryRunInfoFailureOperations[];
4488
4503
  /**
4489
4504
  * @remarks
4490
- * List of data structures that passed the precheck.
4505
+ * The data structs that pass the dry run.
4491
4506
  */
4492
4507
  successComponents?: ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents[];
4493
4508
  /**
4494
4509
  * @remarks
4495
- * List of successfully pre-checked interfaces.
4510
+ * The operations that pass the dry run.
4496
4511
  */
4497
4512
  successOperations?: ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations[];
4498
4513
  /**
4499
4514
  * @remarks
4500
- * Warning messages. If there are any warning messages, some interfaces or data interfaces may not be imported successfully.
4515
+ * The alerts. If an alert is returned, specific operations or structs may fail to be imported.
4501
4516
  */
4502
4517
  warningMessages?: string[];
4503
4518
  static names(): { [key: string]: string } {
@@ -4557,12 +4572,12 @@ export class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
4557
4572
  export class ImportHttpApiResponseBodyData extends $dara.Model {
4558
4573
  /**
4559
4574
  * @remarks
4560
- * Pre-import check result.
4575
+ * The dry run result.
4561
4576
  */
4562
4577
  dryRunInfo?: ImportHttpApiResponseBodyDataDryRunInfo;
4563
4578
  /**
4564
4579
  * @remarks
4565
- * HTTP API ID.
4580
+ * The API ID.
4566
4581
  *
4567
4582
  * @example
4568
4583
  * api-xxx
@@ -4570,7 +4585,7 @@ export class ImportHttpApiResponseBodyData extends $dara.Model {
4570
4585
  httpApiId?: string;
4571
4586
  /**
4572
4587
  * @remarks
4573
- * API name.
4588
+ * The API name.
4574
4589
  *
4575
4590
  * @example
4576
4591
  * import-test
@@ -4607,12 +4622,12 @@ export class ImportHttpApiResponseBodyData extends $dara.Model {
4607
4622
  export class ListDomainsResponseBodyData extends $dara.Model {
4608
4623
  /**
4609
4624
  * @remarks
4610
- * List of domain information.
4625
+ * The information about the domain names.
4611
4626
  */
4612
4627
  items?: DomainInfo[];
4613
4628
  /**
4614
4629
  * @remarks
4615
- * Page number.
4630
+ * The page number of the returned page.
4616
4631
  *
4617
4632
  * @example
4618
4633
  * 1
@@ -4620,7 +4635,7 @@ export class ListDomainsResponseBodyData extends $dara.Model {
4620
4635
  pageNumber?: number;
4621
4636
  /**
4622
4637
  * @remarks
4623
- * Number of items per page.
4638
+ * The number of entries per page.
4624
4639
  *
4625
4640
  * @example
4626
4641
  * 10
@@ -4628,7 +4643,7 @@ export class ListDomainsResponseBodyData extends $dara.Model {
4628
4643
  pageSize?: number;
4629
4644
  /**
4630
4645
  * @remarks
4631
- * Total number of items.
4646
+ * The total number of entries returned.
4632
4647
  *
4633
4648
  * @example
4634
4649
  * 9
@@ -4727,7 +4742,7 @@ export class ListEnvironmentsResponseBodyData extends $dara.Model {
4727
4742
  export class ListGatewaysRequestTag extends $dara.Model {
4728
4743
  /**
4729
4744
  * @remarks
4730
- * The key of the tag.
4745
+ * The key of tag N.
4731
4746
  *
4732
4747
  * @example
4733
4748
  * owner
@@ -4735,7 +4750,7 @@ export class ListGatewaysRequestTag extends $dara.Model {
4735
4750
  key?: string;
4736
4751
  /**
4737
4752
  * @remarks
4738
- * The value of the tag.
4753
+ * The value of tag N.
4739
4754
  *
4740
4755
  * @example
4741
4756
  * zhangsan
@@ -4767,7 +4782,7 @@ export class ListGatewaysRequestTag extends $dara.Model {
4767
4782
  export class ListGatewaysResponseBodyDataItemsLoadBalancersPorts extends $dara.Model {
4768
4783
  /**
4769
4784
  * @remarks
4770
- * Port number.
4785
+ * The port number.
4771
4786
  *
4772
4787
  * @example
4773
4788
  * 443
@@ -4775,9 +4790,10 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancersPorts extends $dara.M
4775
4790
  port?: number;
4776
4791
  /**
4777
4792
  * @remarks
4778
- * Protocol:
4779
- * - TCP
4780
- * - UDP
4793
+ * The protocol. Valid values:
4794
+ *
4795
+ * * TCP
4796
+ * * UDP
4781
4797
  *
4782
4798
  * @example
4783
4799
  * TCP
@@ -4809,7 +4825,7 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancersPorts extends $dara.M
4809
4825
  export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model {
4810
4826
  /**
4811
4827
  * @remarks
4812
- * Load balancer address.
4828
+ * The load balancer IP address.
4813
4829
  *
4814
4830
  * @example
4815
4831
  * nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com
@@ -4817,9 +4833,10 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4817
4833
  address?: string;
4818
4834
  /**
4819
4835
  * @remarks
4820
- * IP version:
4821
- * - ipv4: IPv4.
4822
- * - ipv6: IPv6.
4836
+ * The IP version of the address. Valid values:
4837
+ *
4838
+ * * ipv4: IPv4
4839
+ * * ipv6: IPv6
4823
4840
  *
4824
4841
  * @example
4825
4842
  * ipv4
@@ -4827,9 +4844,10 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4827
4844
  addressIpVersion?: string;
4828
4845
  /**
4829
4846
  * @remarks
4830
- * Load balancer address type:
4831
- * - Internet: Public network.
4832
- * - Intranet: Private network.
4847
+ * The address type. Valid values:
4848
+ *
4849
+ * * Internet
4850
+ * * Intranet
4833
4851
  *
4834
4852
  * @example
4835
4853
  * Internet
@@ -4837,7 +4855,7 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4837
4855
  addressType?: string;
4838
4856
  /**
4839
4857
  * @remarks
4840
- * Indicates whether this is the default entry address for the gateway.
4858
+ * Indicates whether the address is the default ingress address of the instance.
4841
4859
  *
4842
4860
  * @example
4843
4861
  * true
@@ -4845,7 +4863,7 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4845
4863
  gatewayDefault?: boolean;
4846
4864
  /**
4847
4865
  * @remarks
4848
- * Load balancer ID.
4866
+ * The load balancer ID.
4849
4867
  *
4850
4868
  * @example
4851
4869
  * nlb-xqwioje1c91r***
@@ -4853,8 +4871,9 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4853
4871
  loadBalancerId?: string;
4854
4872
  /**
4855
4873
  * @remarks
4856
- * Load balancer provision mode for the gateway:
4857
- * - Managed: Managed by the Cloud Native API Gateway.
4874
+ * The mode in which the load balancer is provided. Valid values:
4875
+ *
4876
+ * * Managed: Cloud-native API Gateway manages and provides the load balancer.
4858
4877
  *
4859
4878
  * @example
4860
4879
  * Managed
@@ -4862,14 +4881,15 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4862
4881
  mode?: string;
4863
4882
  /**
4864
4883
  * @remarks
4865
- * List of listening ports.
4884
+ * The list of listened ports.
4866
4885
  */
4867
4886
  ports?: ListGatewaysResponseBodyDataItemsLoadBalancersPorts[];
4868
4887
  /**
4869
4888
  * @remarks
4870
- * Status of the load balancer:
4871
- * - Ready: Available.
4872
- * - NotCreate: No associated instance.
4889
+ * The load balancer status. Valid values:
4890
+ *
4891
+ * * Ready: The load balancer is available.
4892
+ * * NotCreate: The load balancer is not associated with the instance.
4873
4893
  *
4874
4894
  * @example
4875
4895
  * Ready
@@ -4877,9 +4897,10 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4877
4897
  status?: string;
4878
4898
  /**
4879
4899
  * @remarks
4880
- * Type of load balancer for the gateway:
4881
- * - NLB: Network Load Balancer.
4882
- * - CLB: Classic Load Balancer.
4900
+ * The load balancer type. Valid values:
4901
+ *
4902
+ * * NLB: Network Load Balancer
4903
+ * * CLB: Classic Load Balancer
4883
4904
  *
4884
4905
  * @example
4885
4906
  * NLB
@@ -4928,7 +4949,7 @@ export class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model
4928
4949
  export class ListGatewaysResponseBodyDataItemsSecurityGroup extends $dara.Model {
4929
4950
  /**
4930
4951
  * @remarks
4931
- * The Security Group ID.
4952
+ * The security group ID.
4932
4953
  *
4933
4954
  * @example
4934
4955
  * sg-xxxx
@@ -4958,7 +4979,7 @@ export class ListGatewaysResponseBodyDataItemsSecurityGroup extends $dara.Model
4958
4979
  export class ListGatewaysResponseBodyDataItemsTags extends $dara.Model {
4959
4980
  /**
4960
4981
  * @remarks
4961
- * The key of the tag.
4982
+ * The tag key.
4962
4983
  *
4963
4984
  * @example
4964
4985
  * owner
@@ -4966,7 +4987,7 @@ export class ListGatewaysResponseBodyDataItemsTags extends $dara.Model {
4966
4987
  key?: string;
4967
4988
  /**
4968
4989
  * @remarks
4969
- * The value of the tag.
4990
+ * The tag value.
4970
4991
  *
4971
4992
  * @example
4972
4993
  * zhangsan
@@ -5088,12 +5109,12 @@ export class ListGatewaysResponseBodyDataItemsZonesVSwitch extends $dara.Model {
5088
5109
  export class ListGatewaysResponseBodyDataItemsZones extends $dara.Model {
5089
5110
  /**
5090
5111
  * @remarks
5091
- * The vSwitch.
5112
+ * The vSwitch information.
5092
5113
  */
5093
5114
  vSwitch?: ListGatewaysResponseBodyDataItemsZonesVSwitch;
5094
5115
  /**
5095
5116
  * @remarks
5096
- * The ID of the current zone.
5117
+ * The zone ID.
5097
5118
  *
5098
5119
  * @example
5099
5120
  * cn-hangzhou-f
@@ -5128,10 +5149,10 @@ export class ListGatewaysResponseBodyDataItemsZones extends $dara.Model {
5128
5149
  export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5129
5150
  /**
5130
5151
  * @remarks
5131
- * Charge type
5152
+ * The billing method. Valid values:
5132
5153
  *
5133
- * - POSTPAY: Postpaid (pay-as-you-go)
5134
- * - PREPAY: Prepaid (subscription)
5154
+ * * POSTPAY: pay-as-you-go
5155
+ * * PREPAY: subscription
5135
5156
  *
5136
5157
  * @example
5137
5158
  * POSTPAY
@@ -5139,8 +5160,9 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5139
5160
  chargeType?: string;
5140
5161
  /**
5141
5162
  * @remarks
5142
- * Source of gateway creation:
5143
- * - Console: Console.
5163
+ * The creation source of the instance. Valid values:
5164
+ *
5165
+ * * Console
5144
5166
  *
5145
5167
  * @example
5146
5168
  * Console
@@ -5148,7 +5170,7 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5148
5170
  createFrom?: string;
5149
5171
  /**
5150
5172
  * @remarks
5151
- * Creation timestamp, in milliseconds.
5173
+ * The time when the instance was created. This value is a UNIX timestamp. Unit: milliseconds.
5152
5174
  *
5153
5175
  * @example
5154
5176
  * 1719386834548
@@ -5156,7 +5178,7 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5156
5178
  createTimestamp?: number;
5157
5179
  /**
5158
5180
  * @remarks
5159
- * Expiration timestamp for prepaid (annual or monthly) subscriptions. Unit: milliseconds.
5181
+ * The time when the instance expires. This value is a UNIX timestamp. Unit: milliseconds.
5160
5182
  *
5161
5183
  * @example
5162
5184
  * 172086834548
@@ -5164,7 +5186,7 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5164
5186
  expireTimestamp?: number;
5165
5187
  /**
5166
5188
  * @remarks
5167
- * Gateway ID.
5189
+ * The instance ID.
5168
5190
  *
5169
5191
  * @example
5170
5192
  * gw-cpv54p5***
@@ -5172,12 +5194,12 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5172
5194
  gatewayId?: string;
5173
5195
  /**
5174
5196
  * @remarks
5175
- * List of gateway entry addresses.
5197
+ * The ingress addresses of the instance.
5176
5198
  */
5177
5199
  loadBalancers?: ListGatewaysResponseBodyDataItemsLoadBalancers[];
5178
5200
  /**
5179
5201
  * @remarks
5180
- * Gateway name.
5202
+ * The instance name.
5181
5203
  *
5182
5204
  * @example
5183
5205
  * itemcenter-gateway
@@ -5185,7 +5207,7 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5185
5207
  name?: string;
5186
5208
  /**
5187
5209
  * @remarks
5188
- * Number of gateway instance nodes.
5210
+ * The node quantity of the instance.
5189
5211
  *
5190
5212
  * @example
5191
5213
  * 2
@@ -5193,7 +5215,7 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5193
5215
  replicas?: string;
5194
5216
  /**
5195
5217
  * @remarks
5196
- * Resource group ID.
5218
+ * The resource group ID.
5197
5219
  *
5198
5220
  * @example
5199
5221
  * rg-xxx
@@ -5201,13 +5223,14 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5201
5223
  resourceGroupId?: string;
5202
5224
  /**
5203
5225
  * @remarks
5204
- * The Security Group.
5226
+ * The security group information about the instance.
5205
5227
  */
5206
5228
  securityGroup?: ListGatewaysResponseBodyDataItemsSecurityGroup;
5207
5229
  /**
5208
5230
  * @remarks
5209
- * Gateway specification:
5210
- * - apigw.small.x1: Small specification.
5231
+ * The instance specification. Valid values:
5232
+ *
5233
+ * * apigw.small.x1
5211
5234
  *
5212
5235
  * @example
5213
5236
  * apigw.small.x1
@@ -5215,16 +5238,17 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5215
5238
  spec?: string;
5216
5239
  /**
5217
5240
  * @remarks
5218
- * Gateway status:
5219
- * - Running: Running.
5220
- * - Creating: Creating.
5221
- * - CreateFailed: Creation failed.
5222
- * - Upgrading: Upgrading.
5223
- * - UpgradeFailed: Upgrade failed.
5224
- * - Restarting: Restarting.
5225
- * - RestartFailed: Restart failed.
5226
- * - Deleting: Deleting.
5227
- * - DeleteFailed: Deletion failed.
5241
+ * The instance state. Valid values:
5242
+ *
5243
+ * * Running: The instance is running.
5244
+ * * Creating: The instance is being created.
5245
+ * * CreateFailed: The instance fails to be created.
5246
+ * * Upgrading: The instance is being upgraded.
5247
+ * * UpgradeFailed: The instance fails to be upgraded.
5248
+ * * Restarting: The instance is being restarted.
5249
+ * * RestartFailed: The instance fails to be restarted.
5250
+ * * Deleting: The instance is being released.
5251
+ * * DeleteFailed: The instance failed to be released.
5228
5252
  *
5229
5253
  * @example
5230
5254
  * Running
@@ -5232,17 +5256,17 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5232
5256
  status?: string;
5233
5257
  /**
5234
5258
  * @remarks
5235
- * List of sub domain information
5259
+ * The second-level domain names.
5236
5260
  */
5237
5261
  subDomainInfos?: SubDomainInfo[];
5238
5262
  /**
5239
5263
  * @remarks
5240
- * Array of tags.
5264
+ * The tags.
5241
5265
  */
5242
5266
  tags?: ListGatewaysResponseBodyDataItemsTags[];
5243
5267
  /**
5244
5268
  * @remarks
5245
- * Target version of the gateway. When it is inconsistent with the current `version`, an upgrade can be performed.
5269
+ * The destination version of the instance. If the value is inconsistent with the current version, you can upgrade the instance.
5246
5270
  *
5247
5271
  * @example
5248
5272
  * 2.0.2
@@ -5250,7 +5274,7 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5250
5274
  targetVersion?: string;
5251
5275
  /**
5252
5276
  * @remarks
5253
- * Update timestamp. Unit: milliseconds.
5277
+ * The time when the instance was last updated. This value is a UNIX timestamp. Unit: milliseconds.
5254
5278
  *
5255
5279
  * @example
5256
5280
  * 1719386834548
@@ -5258,12 +5282,12 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5258
5282
  updateTimestamp?: number;
5259
5283
  /**
5260
5284
  * @remarks
5261
- * The vSwtich.
5285
+ * The vSwitch information.
5262
5286
  */
5263
5287
  vSwitch?: ListGatewaysResponseBodyDataItemsVSwitch;
5264
5288
  /**
5265
5289
  * @remarks
5266
- * Gateway version.
5290
+ * The instance version.
5267
5291
  *
5268
5292
  * @example
5269
5293
  * 2.0.2
@@ -5271,12 +5295,12 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5271
5295
  version?: string;
5272
5296
  /**
5273
5297
  * @remarks
5274
- * The VPC.
5298
+ * The virtual private cloud (VPC) information of the instance.
5275
5299
  */
5276
5300
  vpc?: ListGatewaysResponseBodyDataItemsVpc;
5277
5301
  /**
5278
5302
  * @remarks
5279
- * The Zones.
5303
+ * The availability zones of the instance.
5280
5304
  */
5281
5305
  zones?: ListGatewaysResponseBodyDataItemsZones[];
5282
5306
  static names(): { [key: string]: string } {
@@ -5362,12 +5386,12 @@ export class ListGatewaysResponseBodyDataItems extends $dara.Model {
5362
5386
  export class ListGatewaysResponseBodyData extends $dara.Model {
5363
5387
  /**
5364
5388
  * @remarks
5365
- * Gateway list
5389
+ * The instances.
5366
5390
  */
5367
5391
  items?: ListGatewaysResponseBodyDataItems[];
5368
5392
  /**
5369
5393
  * @remarks
5370
- * Page number.
5394
+ * The page number of the returned page.
5371
5395
  *
5372
5396
  * @example
5373
5397
  * 1
@@ -5375,7 +5399,7 @@ export class ListGatewaysResponseBodyData extends $dara.Model {
5375
5399
  pageNumber?: number;
5376
5400
  /**
5377
5401
  * @remarks
5378
- * Page size.
5402
+ * The number of entries per page.
5379
5403
  *
5380
5404
  * @example
5381
5405
  * 10
@@ -5383,7 +5407,7 @@ export class ListGatewaysResponseBodyData extends $dara.Model {
5383
5407
  pageSize?: number;
5384
5408
  /**
5385
5409
  * @remarks
5386
- * Total count.
5410
+ * The total number of entries returned.
5387
5411
  *
5388
5412
  * @example
5389
5413
  * 6
@@ -5482,12 +5506,12 @@ export class ListHttpApiOperationsResponseBodyData extends $dara.Model {
5482
5506
  export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
5483
5507
  /**
5484
5508
  * @remarks
5485
- * List of routes.
5509
+ * The routes.
5486
5510
  */
5487
5511
  items?: HttpRoute[];
5488
5512
  /**
5489
5513
  * @remarks
5490
- * Page number.
5514
+ * The page number of the returned page.
5491
5515
  *
5492
5516
  * @example
5493
5517
  * 1
@@ -5495,7 +5519,7 @@ export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
5495
5519
  pageNumber?: number;
5496
5520
  /**
5497
5521
  * @remarks
5498
- * Page size.
5522
+ * The number of entries per page.
5499
5523
  *
5500
5524
  * @example
5501
5525
  * 20
@@ -5503,7 +5527,7 @@ export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
5503
5527
  pageSize?: number;
5504
5528
  /**
5505
5529
  * @remarks
5506
- * Total number of items.
5530
+ * The total number of entries returned.
5507
5531
  *
5508
5532
  * @example
5509
5533
  * 9
@@ -5542,12 +5566,12 @@ export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
5542
5566
  export class ListHttpApisResponseBodyData extends $dara.Model {
5543
5567
  /**
5544
5568
  * @remarks
5545
- * API information.
5569
+ * The API information.
5546
5570
  */
5547
5571
  items?: HttpApiInfoByName[];
5548
5572
  /**
5549
5573
  * @remarks
5550
- * Page number.
5574
+ * The page number of the returned page.
5551
5575
  *
5552
5576
  * @example
5553
5577
  * 1
@@ -5555,7 +5579,7 @@ export class ListHttpApisResponseBodyData extends $dara.Model {
5555
5579
  pageNumber?: number;
5556
5580
  /**
5557
5581
  * @remarks
5558
- * Page size.
5582
+ * The number of entries per page.
5559
5583
  *
5560
5584
  * @example
5561
5585
  * 10
@@ -5563,7 +5587,7 @@ export class ListHttpApisResponseBodyData extends $dara.Model {
5563
5587
  pageSize?: number;
5564
5588
  /**
5565
5589
  * @remarks
5566
- * Total count.
5590
+ * The total number of entries returned.
5567
5591
  *
5568
5592
  * @example
5569
5593
  * 10
@@ -5662,12 +5686,12 @@ export class ListPolicyClassesResponseBodyData extends $dara.Model {
5662
5686
  export class ListServicesResponseBodyData extends $dara.Model {
5663
5687
  /**
5664
5688
  * @remarks
5665
- * Service list.
5689
+ * The services.
5666
5690
  */
5667
5691
  items?: Service[];
5668
5692
  /**
5669
5693
  * @remarks
5670
- * Page number.
5694
+ * The page number of the returned page.
5671
5695
  *
5672
5696
  * @example
5673
5697
  * 1
@@ -5675,7 +5699,7 @@ export class ListServicesResponseBodyData extends $dara.Model {
5675
5699
  pageNumber?: number;
5676
5700
  /**
5677
5701
  * @remarks
5678
- * Page size.
5702
+ * The number of entries per page.
5679
5703
  *
5680
5704
  * @example
5681
5705
  * 10
@@ -5683,7 +5707,7 @@ export class ListServicesResponseBodyData extends $dara.Model {
5683
5707
  pageSize?: number;
5684
5708
  /**
5685
5709
  * @remarks
5686
- * Total count.
5710
+ * The total number of entries returned.
5687
5711
  *
5688
5712
  * @example
5689
5713
  * 18
@@ -5842,7 +5866,7 @@ export class ListZonesResponseBodyData extends $dara.Model {
5842
5866
  export class UpdateDomainResponseBodyData extends $dara.Model {
5843
5867
  /**
5844
5868
  * @remarks
5845
- * Deploy revision id.
5869
+ * The released version ID.
5846
5870
  *
5847
5871
  * @example
5848
5872
  * apr-xxx
@@ -5942,7 +5966,7 @@ export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
5942
5966
  export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model {
5943
5967
  /**
5944
5968
  * @remarks
5945
- * Service port, do not pass in for dynamic ports.
5969
+ * The service port. If you want to use a dynamic port, do not pass this parameter.
5946
5970
  *
5947
5971
  * @example
5948
5972
  * 8080
@@ -5950,9 +5974,10 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
5950
5974
  port?: number;
5951
5975
  /**
5952
5976
  * @remarks
5953
- * Service protocol:
5954
- * - HTTP.
5955
- * - HTTPS.
5977
+ * The protocol. Valid values:
5978
+ *
5979
+ * * HTTP
5980
+ * * HTTPS
5956
5981
  *
5957
5982
  * @example
5958
5983
  * HTTP
@@ -5960,7 +5985,7 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
5960
5985
  protocol?: string;
5961
5986
  /**
5962
5987
  * @remarks
5963
- * Service ID.
5988
+ * The service ID.
5964
5989
  *
5965
5990
  * @example
5966
5991
  * svc-cr6pk4tlhtgm58e***
@@ -5968,7 +5993,7 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
5968
5993
  serviceId?: string;
5969
5994
  /**
5970
5995
  * @remarks
5971
- * Service version.
5996
+ * The service version.
5972
5997
  *
5973
5998
  * @example
5974
5999
  * v1
@@ -5976,7 +6001,7 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
5976
6001
  version?: string;
5977
6002
  /**
5978
6003
  * @remarks
5979
- * Percentage value of traffic ratio.
6004
+ * The percentage value of traffic.
5980
6005
  *
5981
6006
  * @example
5982
6007
  * 49
@@ -6014,7 +6039,14 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
6014
6039
  export class UpdateHttpApiRouteRequestBackendConfig extends $dara.Model {
6015
6040
  /**
6016
6041
  * @remarks
6017
- * Backend service scenario.
6042
+ * The backend service scenario.
6043
+ *
6044
+ * Valid values:
6045
+ *
6046
+ * * SingleService
6047
+ * * MultiServiceByRatio
6048
+ * * Redirect
6049
+ * * Mock
6018
6050
  *
6019
6051
  * @example
6020
6052
  * SingleService
@@ -6022,7 +6054,7 @@ export class UpdateHttpApiRouteRequestBackendConfig extends $dara.Model {
6022
6054
  scene?: string;
6023
6055
  /**
6024
6056
  * @remarks
6025
- * List of backend services.
6057
+ * The backend services.
6026
6058
  */
6027
6059
  services?: UpdateHttpApiRouteRequestBackendConfigServices[];
6028
6060
  static names(): { [key: string]: string } {
@@ -8583,7 +8615,7 @@ export class ChangeResourceGroupResponse extends $dara.Model {
8583
8615
  export class CreateDomainRequest extends $dara.Model {
8584
8616
  /**
8585
8617
  * @remarks
8586
- * CA Certificate Identifier.
8618
+ * The CA certificate ID.
8587
8619
  *
8588
8620
  * @example
8589
8621
  * 1ef1da5f-38ed-69b3-****-037781890265
@@ -8591,7 +8623,7 @@ export class CreateDomainRequest extends $dara.Model {
8591
8623
  caCertIdentifier?: string;
8592
8624
  /**
8593
8625
  * @remarks
8594
- * Certificate Unique Identifier.
8626
+ * The certificate ID.
8595
8627
  *
8596
8628
  * @example
8597
8629
  * 1ef1da5f-38ed-69b3-****-037781890265
@@ -8599,7 +8631,7 @@ export class CreateDomainRequest extends $dara.Model {
8599
8631
  certIdentifier?: string;
8600
8632
  /**
8601
8633
  * @remarks
8602
- * Client CA Certificate
8634
+ * The client CA certificate.
8603
8635
  *
8604
8636
  * @example
8605
8637
  * -----BEGIN CERTIFICATE-----
@@ -8611,7 +8643,7 @@ export class CreateDomainRequest extends $dara.Model {
8611
8643
  clientCACert?: string;
8612
8644
  /**
8613
8645
  * @remarks
8614
- * Set the HTTPS protocol type, whether to enable forced HTTPS redirection.
8646
+ * Specifies whether to enable forcible HTTPS redirection.
8615
8647
  *
8616
8648
  * @example
8617
8649
  * false
@@ -8619,7 +8651,13 @@ export class CreateDomainRequest extends $dara.Model {
8619
8651
  forceHttps?: boolean;
8620
8652
  /**
8621
8653
  * @remarks
8622
- * HTTP/2 settings.
8654
+ * The HTTP/2 configuration.
8655
+ *
8656
+ * Valid values:
8657
+ *
8658
+ * * GlobalConfig
8659
+ * * Close
8660
+ * * Open
8623
8661
  *
8624
8662
  * @example
8625
8663
  * Open
@@ -8627,12 +8665,12 @@ export class CreateDomainRequest extends $dara.Model {
8627
8665
  http2Option?: string;
8628
8666
  /**
8629
8667
  * @remarks
8630
- * Whether to enable mTLS mutual authentication
8668
+ * Specifies whether to enable mutual authentication.
8631
8669
  */
8632
8670
  mTLSEnabled?: boolean;
8633
8671
  /**
8634
8672
  * @remarks
8635
- * Domain name.
8673
+ * The domain name.
8636
8674
  *
8637
8675
  * This parameter is required.
8638
8676
  *
@@ -8642,10 +8680,10 @@ export class CreateDomainRequest extends $dara.Model {
8642
8680
  name?: string;
8643
8681
  /**
8644
8682
  * @remarks
8645
- * The protocol type supported by the domain.
8683
+ * The protocol type supported by the domain name.
8646
8684
  *
8647
- * - HTTP: Supports only HTTP protocol.
8648
- * - HTTPS: Supports only HTTPS protocol.
8685
+ * * HTTP: Only HTTP is supported.
8686
+ * * HTTPS: Only HTTPS is supported.
8649
8687
  *
8650
8688
  * This parameter is required.
8651
8689
  *
@@ -8655,7 +8693,7 @@ export class CreateDomainRequest extends $dara.Model {
8655
8693
  protocol?: string;
8656
8694
  /**
8657
8695
  * @remarks
8658
- * The ID of the resource group.
8696
+ * The [resource group ID](https://help.aliyun.com/document_detail/151181.html).
8659
8697
  *
8660
8698
  * @example
8661
8699
  * rg-aekzoiafjtr7zyq
@@ -8663,12 +8701,12 @@ export class CreateDomainRequest extends $dara.Model {
8663
8701
  resourceGroupId?: string;
8664
8702
  /**
8665
8703
  * @remarks
8666
- * The TLS cipher suites config.
8704
+ * The cipher suite configuration.
8667
8705
  */
8668
8706
  tlsCipherSuitesConfig?: TlsCipherSuitesConfig;
8669
8707
  /**
8670
8708
  * @remarks
8671
- * Maximum TLS protocol version, supports up to TLS 1.3.
8709
+ * The maximum version of the TLS protocol. Up to TLS 1.3 is supported.
8672
8710
  *
8673
8711
  * @example
8674
8712
  * TLS1.3
@@ -8676,7 +8714,7 @@ export class CreateDomainRequest extends $dara.Model {
8676
8714
  tlsMax?: string;
8677
8715
  /**
8678
8716
  * @remarks
8679
- * Minimum TLS protocol version, supports down to TLS 1.0.
8717
+ * The minimum version of the TLS protocol. Down to TLS 1.0 is supported.
8680
8718
  *
8681
8719
  * @example
8682
8720
  * TLS1.0
@@ -8731,7 +8769,7 @@ export class CreateDomainRequest extends $dara.Model {
8731
8769
  export class CreateDomainResponseBody extends $dara.Model {
8732
8770
  /**
8733
8771
  * @remarks
8734
- * Response code.
8772
+ * The status code returned.
8735
8773
  *
8736
8774
  * @example
8737
8775
  * Ok
@@ -8739,12 +8777,12 @@ export class CreateDomainResponseBody extends $dara.Model {
8739
8777
  code?: string;
8740
8778
  /**
8741
8779
  * @remarks
8742
- * Response data.
8780
+ * The response data.
8743
8781
  */
8744
8782
  data?: CreateDomainResponseBodyData;
8745
8783
  /**
8746
8784
  * @remarks
8747
- * Response message.
8785
+ * The response message returned.
8748
8786
  *
8749
8787
  * @example
8750
8788
  * success
@@ -8752,7 +8790,7 @@ export class CreateDomainResponseBody extends $dara.Model {
8752
8790
  message?: string;
8753
8791
  /**
8754
8792
  * @remarks
8755
- * Request ID, used for tracing the API call chain.
8793
+ * The request ID, which is used to trace the API call link.
8756
8794
  *
8757
8795
  * @example
8758
8796
  * 0C2D1C68-0D93-5561-8EE6-FDB7BF067A30
@@ -8997,13 +9035,19 @@ export class CreateEnvironmentResponse extends $dara.Model {
8997
9035
  export class CreateHttpApiRequest extends $dara.Model {
8998
9036
  /**
8999
9037
  * @remarks
9000
- * The AI protocols list.
9038
+ * The AI API protocols. Valid value:
9039
+ *
9040
+ * * OpenAI/v1
9001
9041
  */
9002
9042
  aiProtocols?: string[];
9043
+ /**
9044
+ * @remarks
9045
+ * The authentication configurations.
9046
+ */
9003
9047
  authConfig?: AuthConfig;
9004
9048
  /**
9005
9049
  * @remarks
9006
- * Base path of the API, which must start with a \\"/\\".
9050
+ * The API base path, which must start with a forward slash (/).
9007
9051
  *
9008
9052
  * @example
9009
9053
  * /v1
@@ -9011,26 +9055,30 @@ export class CreateHttpApiRequest extends $dara.Model {
9011
9055
  basePath?: string;
9012
9056
  /**
9013
9057
  * @remarks
9014
- * The deploy configs.
9058
+ * The API deployment configurations. Currently, only AI APIs support deployment configurations, and only a single deployment configuration can be passed.
9015
9059
  */
9016
9060
  deployConfigs?: HttpApiDeployConfig[];
9017
9061
  /**
9018
9062
  * @remarks
9019
- * Description of the API.
9063
+ * The API description.
9020
9064
  *
9021
9065
  * @example
9022
- * 测试专用API。
9066
+ * API for testing
9023
9067
  */
9024
9068
  description?: string;
9069
+ /**
9070
+ * @remarks
9071
+ * Specifies whether to enable authentication.
9072
+ */
9025
9073
  enableAuth?: boolean;
9026
9074
  /**
9027
9075
  * @remarks
9028
- * Configuration information for the HTTP Ingress API.
9076
+ * The HTTP Ingress configurations.
9029
9077
  */
9030
9078
  ingressConfig?: CreateHttpApiRequestIngressConfig;
9031
9079
  /**
9032
9080
  * @remarks
9033
- * Name of the API.
9081
+ * The API name.
9034
9082
  *
9035
9083
  * This parameter is required.
9036
9084
  *
@@ -9040,12 +9088,12 @@ export class CreateHttpApiRequest extends $dara.Model {
9040
9088
  name?: string;
9041
9089
  /**
9042
9090
  * @remarks
9043
- * List of API access protocols.
9091
+ * The protocols that are used to call the API.
9044
9092
  */
9045
9093
  protocols?: string[];
9046
9094
  /**
9047
9095
  * @remarks
9048
- * The ID of the resource group.
9096
+ * The resource group ID.
9049
9097
  *
9050
9098
  * @example
9051
9099
  * rg-aekzgvmlotionbi
@@ -9053,11 +9101,12 @@ export class CreateHttpApiRequest extends $dara.Model {
9053
9101
  resourceGroupId?: string;
9054
9102
  /**
9055
9103
  * @remarks
9056
- * Type of the HTTP API.
9057
- * - Http
9058
- * - Rest
9059
- * - WebSocket
9060
- * - HttpIngress
9104
+ * The API type. Valid values:
9105
+ *
9106
+ * * Http
9107
+ * * Rest
9108
+ * * WebSocket
9109
+ * * HttpIngress
9061
9110
  *
9062
9111
  * @example
9063
9112
  * Http
@@ -9065,7 +9114,7 @@ export class CreateHttpApiRequest extends $dara.Model {
9065
9114
  type?: string;
9066
9115
  /**
9067
9116
  * @remarks
9068
- * Versioning configuration for the API.
9117
+ * The versioning configuration of the API.
9069
9118
  */
9070
9119
  versionConfig?: HttpApiVersionConfig;
9071
9120
  static names(): { [key: string]: string } {
@@ -9132,7 +9181,7 @@ export class CreateHttpApiRequest extends $dara.Model {
9132
9181
  export class CreateHttpApiResponseBody extends $dara.Model {
9133
9182
  /**
9134
9183
  * @remarks
9135
- * Status code.
9184
+ * The status code.
9136
9185
  *
9137
9186
  * @example
9138
9187
  * Ok
@@ -9140,12 +9189,12 @@ export class CreateHttpApiResponseBody extends $dara.Model {
9140
9189
  code?: string;
9141
9190
  /**
9142
9191
  * @remarks
9143
- * API information.
9192
+ * The API information.
9144
9193
  */
9145
9194
  data?: CreateHttpApiResponseBodyData;
9146
9195
  /**
9147
9196
  * @remarks
9148
- * Response message.
9197
+ * The returned message.
9149
9198
  *
9150
9199
  * @example
9151
9200
  * success
@@ -9153,7 +9202,7 @@ export class CreateHttpApiResponseBody extends $dara.Model {
9153
9202
  message?: string;
9154
9203
  /**
9155
9204
  * @remarks
9156
- * Request ID.
9205
+ * The request ID.
9157
9206
  *
9158
9207
  * @example
9159
9208
  * A1994B10-C6A8-58FA-8347-6A08B0D4EFDE
@@ -9863,7 +9912,7 @@ export class CreatePolicyAttachmentResponse extends $dara.Model {
9863
9912
  export class CreateServiceRequest extends $dara.Model {
9864
9913
  /**
9865
9914
  * @remarks
9866
- * Gateway ID.
9915
+ * The gateway instance ID.
9867
9916
  *
9868
9917
  * @example
9869
9918
  * gw-cq7l5s5lhtg***
@@ -9871,7 +9920,7 @@ export class CreateServiceRequest extends $dara.Model {
9871
9920
  gatewayId?: string;
9872
9921
  /**
9873
9922
  * @remarks
9874
- * Resource group ID.
9923
+ * The resource group ID.
9875
9924
  *
9876
9925
  * @example
9877
9926
  * rg-xxx
@@ -9879,18 +9928,28 @@ export class CreateServiceRequest extends $dara.Model {
9879
9928
  resourceGroupId?: string;
9880
9929
  /**
9881
9930
  * @remarks
9882
- * List of service configuration information.
9931
+ * The list of service configurations.
9883
9932
  */
9884
9933
  serviceConfigs?: CreateServiceRequestServiceConfigs[];
9885
9934
  /**
9886
9935
  * @remarks
9887
- * Service source:
9888
- * - MSE_NACOS: Services in MSE Nacos.
9889
- * - K8S: Services in the K8S cluster of container service.
9890
- * - VIP: Fixed address service.
9891
- * - DNS: DNS domain name service.
9892
- * - FC3: Function Compute service.
9893
- * - SAE_K8S_SERVICE: SAE K8S service.
9936
+ * The service source. Valid values:
9937
+ *
9938
+ * * MSE_NACOS: a service in an MSE Nacos instance
9939
+ * * K8S: a service in a Kubernetes (K8s) cluster in Container Service for Kubernetes (ACK)
9940
+ * * VIP: a fixed IP address
9941
+ * * DNS: a Domain Name System (DNS) domain name
9942
+ * * FC3: a service in Function Compute
9943
+ * * SAE_K8S_SERVICE: a service in a K8s cluster in Serverless App Engine (SAE)
9944
+ *
9945
+ * Enumerated values:
9946
+ *
9947
+ * * SAE_K8S_SERVICE
9948
+ * * K8S
9949
+ * * FC3
9950
+ * * DNS
9951
+ * * VIP
9952
+ * * MSE_NACOS
9894
9953
  *
9895
9954
  * @example
9896
9955
  * MSE_NACOS
@@ -9929,7 +9988,7 @@ export class CreateServiceRequest extends $dara.Model {
9929
9988
  export class CreateServiceResponseBody extends $dara.Model {
9930
9989
  /**
9931
9990
  * @remarks
9932
- * Response status code.
9991
+ * The status code.
9933
9992
  *
9934
9993
  * @example
9935
9994
  * Ok
@@ -9937,12 +9996,12 @@ export class CreateServiceResponseBody extends $dara.Model {
9937
9996
  code?: string;
9938
9997
  /**
9939
9998
  * @remarks
9940
- * Response data.
9999
+ * The response data.
9941
10000
  */
9942
10001
  data?: CreateServiceResponseBodyData;
9943
10002
  /**
9944
10003
  * @remarks
9945
- * Response message.
10004
+ * The returned message.
9946
10005
  *
9947
10006
  * @example
9948
10007
  * success
@@ -9950,7 +10009,7 @@ export class CreateServiceResponseBody extends $dara.Model {
9950
10009
  message?: string;
9951
10010
  /**
9952
10011
  * @remarks
9953
- * Request ID.
10012
+ * The request ID.
9954
10013
  *
9955
10014
  * @example
9956
10015
  * C67DED2B-F19B-5BEC-88C1-D6EB854CD0D4
@@ -11039,8 +11098,7 @@ export class ExportHttpApiResponse extends $dara.Model {
11039
11098
  export class GetDashboardRequest extends $dara.Model {
11040
11099
  /**
11041
11100
  * @remarks
11042
- * zh: Chinese
11043
- * en: English
11101
+ * The language. Valid values: zh (Chinese) and en (English).
11044
11102
  *
11045
11103
  * @example
11046
11104
  * zh
@@ -11056,14 +11114,15 @@ export class GetDashboardRequest extends $dara.Model {
11056
11114
  apiId?: string;
11057
11115
  /**
11058
11116
  * @remarks
11059
- * Filter configuration
11117
+ * The filter configurations.
11060
11118
  */
11061
11119
  filter?: GetDashboardRequestFilter;
11062
11120
  /**
11063
11121
  * @remarks
11064
- * Dashboard name:
11065
- * - LOG: Access log
11066
- * - PLUGIN: Plugin log
11122
+ * The dashboard name.
11123
+ *
11124
+ * * LOG: access logs
11125
+ * * PLUGIN: plug-in logs
11067
11126
  *
11068
11127
  * @example
11069
11128
  * PLUGIN
@@ -11071,21 +11130,24 @@ export class GetDashboardRequest extends $dara.Model {
11071
11130
  name?: string;
11072
11131
  /**
11073
11132
  * @remarks
11074
- * Plugin ID.
11133
+ * The plug-in ID.
11075
11134
  *
11076
11135
  * @example
11077
11136
  * pls-dn82a9djd8z****
11078
11137
  */
11079
11138
  pluginClassId?: string;
11139
+ pluginId?: string;
11080
11140
  /**
11081
11141
  * @remarks
11082
- * Dashboard source:
11083
- * - SLS: Log dashboard
11142
+ * The dashboard source. Valid values:
11143
+ *
11144
+ * * SLS: Simple Log Service
11084
11145
  *
11085
11146
  * @example
11086
11147
  * SLS
11087
11148
  */
11088
11149
  source?: string;
11150
+ upstreamCluster?: string;
11089
11151
  static names(): { [key: string]: string } {
11090
11152
  return {
11091
11153
  acceptLanguage: 'acceptLanguage',
@@ -11093,7 +11155,9 @@ export class GetDashboardRequest extends $dara.Model {
11093
11155
  filter: 'filter',
11094
11156
  name: 'name',
11095
11157
  pluginClassId: 'pluginClassId',
11158
+ pluginId: 'pluginId',
11096
11159
  source: 'source',
11160
+ upstreamCluster: 'upstreamCluster',
11097
11161
  };
11098
11162
  }
11099
11163
 
@@ -11104,7 +11168,9 @@ export class GetDashboardRequest extends $dara.Model {
11104
11168
  filter: GetDashboardRequestFilter,
11105
11169
  name: 'string',
11106
11170
  pluginClassId: 'string',
11171
+ pluginId: 'string',
11107
11172
  source: 'string',
11173
+ upstreamCluster: 'string',
11108
11174
  };
11109
11175
  }
11110
11176
 
@@ -11123,8 +11189,7 @@ export class GetDashboardRequest extends $dara.Model {
11123
11189
  export class GetDashboardShrinkRequest extends $dara.Model {
11124
11190
  /**
11125
11191
  * @remarks
11126
- * zh: Chinese
11127
- * en: English
11192
+ * The language. Valid values: zh (Chinese) and en (English).
11128
11193
  *
11129
11194
  * @example
11130
11195
  * zh
@@ -11140,14 +11205,15 @@ export class GetDashboardShrinkRequest extends $dara.Model {
11140
11205
  apiId?: string;
11141
11206
  /**
11142
11207
  * @remarks
11143
- * Filter configuration
11208
+ * The filter configurations.
11144
11209
  */
11145
11210
  filterShrink?: string;
11146
11211
  /**
11147
11212
  * @remarks
11148
- * Dashboard name:
11149
- * - LOG: Access log
11150
- * - PLUGIN: Plugin log
11213
+ * The dashboard name.
11214
+ *
11215
+ * * LOG: access logs
11216
+ * * PLUGIN: plug-in logs
11151
11217
  *
11152
11218
  * @example
11153
11219
  * PLUGIN
@@ -11155,21 +11221,24 @@ export class GetDashboardShrinkRequest extends $dara.Model {
11155
11221
  name?: string;
11156
11222
  /**
11157
11223
  * @remarks
11158
- * Plugin ID.
11224
+ * The plug-in ID.
11159
11225
  *
11160
11226
  * @example
11161
11227
  * pls-dn82a9djd8z****
11162
11228
  */
11163
11229
  pluginClassId?: string;
11230
+ pluginId?: string;
11164
11231
  /**
11165
11232
  * @remarks
11166
- * Dashboard source:
11167
- * - SLS: Log dashboard
11233
+ * The dashboard source. Valid values:
11234
+ *
11235
+ * * SLS: Simple Log Service
11168
11236
  *
11169
11237
  * @example
11170
11238
  * SLS
11171
11239
  */
11172
11240
  source?: string;
11241
+ upstreamCluster?: string;
11173
11242
  static names(): { [key: string]: string } {
11174
11243
  return {
11175
11244
  acceptLanguage: 'acceptLanguage',
@@ -11177,7 +11246,9 @@ export class GetDashboardShrinkRequest extends $dara.Model {
11177
11246
  filterShrink: 'filter',
11178
11247
  name: 'name',
11179
11248
  pluginClassId: 'pluginClassId',
11249
+ pluginId: 'pluginId',
11180
11250
  source: 'source',
11251
+ upstreamCluster: 'upstreamCluster',
11181
11252
  };
11182
11253
  }
11183
11254
 
@@ -11188,7 +11259,9 @@ export class GetDashboardShrinkRequest extends $dara.Model {
11188
11259
  filterShrink: 'string',
11189
11260
  name: 'string',
11190
11261
  pluginClassId: 'string',
11262
+ pluginId: 'string',
11191
11263
  source: 'string',
11264
+ upstreamCluster: 'string',
11192
11265
  };
11193
11266
  }
11194
11267
 
@@ -11204,7 +11277,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
11204
11277
  export class GetDashboardResponseBody extends $dara.Model {
11205
11278
  /**
11206
11279
  * @remarks
11207
- * Response code
11280
+ * The HTTP status code.
11208
11281
  *
11209
11282
  * @example
11210
11283
  * 200
@@ -11212,12 +11285,12 @@ export class GetDashboardResponseBody extends $dara.Model {
11212
11285
  code?: number;
11213
11286
  /**
11214
11287
  * @remarks
11215
- * Response data
11288
+ * The data returned.
11216
11289
  */
11217
11290
  data?: GetDashboardResponseBodyData;
11218
11291
  /**
11219
11292
  * @remarks
11220
- * Backend error code
11293
+ * The error code.
11221
11294
  *
11222
11295
  * @example
11223
11296
  * Ok
@@ -11225,7 +11298,7 @@ export class GetDashboardResponseBody extends $dara.Model {
11225
11298
  errorCode?: string;
11226
11299
  /**
11227
11300
  * @remarks
11228
- * Error message
11301
+ * The error message.
11229
11302
  *
11230
11303
  * @example
11231
11304
  * success
@@ -11233,7 +11306,7 @@ export class GetDashboardResponseBody extends $dara.Model {
11233
11306
  message?: string;
11234
11307
  /**
11235
11308
  * @remarks
11236
- * Request ID
11309
+ * The request ID.
11237
11310
  *
11238
11311
  * @example
11239
11312
  * 2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
@@ -11241,7 +11314,7 @@ export class GetDashboardResponseBody extends $dara.Model {
11241
11314
  requestId?: string;
11242
11315
  /**
11243
11316
  * @remarks
11244
- * Whether the request was successful
11317
+ * Indicates whether the request was successful.
11245
11318
  *
11246
11319
  * @example
11247
11320
  * true
@@ -11319,7 +11392,7 @@ export class GetDashboardResponse extends $dara.Model {
11319
11392
  export class GetDomainRequest extends $dara.Model {
11320
11393
  /**
11321
11394
  * @remarks
11322
- * Indicates whether include domain related resource information.
11395
+ * Specifies whether to return online resource information.
11323
11396
  *
11324
11397
  * @example
11325
11398
  * true
@@ -11349,7 +11422,7 @@ export class GetDomainRequest extends $dara.Model {
11349
11422
  export class GetDomainResponseBody extends $dara.Model {
11350
11423
  /**
11351
11424
  * @remarks
11352
- * Response code.
11425
+ * The status code returned.
11353
11426
  *
11354
11427
  * @example
11355
11428
  * Ok
@@ -11357,12 +11430,12 @@ export class GetDomainResponseBody extends $dara.Model {
11357
11430
  code?: string;
11358
11431
  /**
11359
11432
  * @remarks
11360
- * Response data.
11433
+ * The data returned.
11361
11434
  */
11362
11435
  data?: GetDomainResponseBodyData;
11363
11436
  /**
11364
11437
  * @remarks
11365
- * Response message.
11438
+ * The response message returned.
11366
11439
  *
11367
11440
  * @example
11368
11441
  * success
@@ -11370,7 +11443,7 @@ export class GetDomainResponseBody extends $dara.Model {
11370
11443
  message?: string;
11371
11444
  /**
11372
11445
  * @remarks
11373
- * Request ID, used for tracing the API call chain.
11446
+ * The request ID, which is used to trace the API call link.
11374
11447
  *
11375
11448
  * @example
11376
11449
  * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
@@ -11864,7 +11937,7 @@ export class GetHttpApiOperationResponse extends $dara.Model {
11864
11937
  export class GetHttpApiRouteResponseBody extends $dara.Model {
11865
11938
  /**
11866
11939
  * @remarks
11867
- * Response status code.
11940
+ * The status code.
11868
11941
  *
11869
11942
  * @example
11870
11943
  * Ok
@@ -11872,12 +11945,12 @@ export class GetHttpApiRouteResponseBody extends $dara.Model {
11872
11945
  code?: string;
11873
11946
  /**
11874
11947
  * @remarks
11875
- * Route detail data.
11948
+ * The route details.
11876
11949
  */
11877
11950
  data?: HttpRoute;
11878
11951
  /**
11879
11952
  * @remarks
11880
- * Response message.
11953
+ * The returned message.
11881
11954
  *
11882
11955
  * @example
11883
11956
  * success
@@ -11885,7 +11958,7 @@ export class GetHttpApiRouteResponseBody extends $dara.Model {
11885
11958
  message?: string;
11886
11959
  /**
11887
11960
  * @remarks
11888
- * Request ID.
11961
+ * The request ID.
11889
11962
  *
11890
11963
  * @example
11891
11964
  * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
@@ -11959,7 +12032,7 @@ export class GetHttpApiRouteResponse extends $dara.Model {
11959
12032
  export class GetPolicyResponseBody extends $dara.Model {
11960
12033
  /**
11961
12034
  * @remarks
11962
- * Response code.
12035
+ * The status code.
11963
12036
  *
11964
12037
  * @example
11965
12038
  * Ok
@@ -11967,12 +12040,12 @@ export class GetPolicyResponseBody extends $dara.Model {
11967
12040
  code?: string;
11968
12041
  /**
11969
12042
  * @remarks
11970
- * Response data.
12043
+ * The data returned.
11971
12044
  */
11972
12045
  data?: PolicyDetailInfo;
11973
12046
  /**
11974
12047
  * @remarks
11975
- * Response message.
12048
+ * The returned message.
11976
12049
  *
11977
12050
  * @example
11978
12051
  * success
@@ -11980,7 +12053,7 @@ export class GetPolicyResponseBody extends $dara.Model {
11980
12053
  message?: string;
11981
12054
  /**
11982
12055
  * @remarks
11983
- * Id of the request
12056
+ * The request ID.
11984
12057
  *
11985
12058
  * @example
11986
12059
  * 2F46B9E7-67EF-5C8A-BA52-D38D5B32A***
@@ -12244,7 +12317,7 @@ export class GetResourceOverviewResponse extends $dara.Model {
12244
12317
  export class GetServiceResponseBody extends $dara.Model {
12245
12318
  /**
12246
12319
  * @remarks
12247
- * Response status code.
12320
+ * The status code.
12248
12321
  *
12249
12322
  * @example
12250
12323
  * Ok
@@ -12252,12 +12325,12 @@ export class GetServiceResponseBody extends $dara.Model {
12252
12325
  code?: string;
12253
12326
  /**
12254
12327
  * @remarks
12255
- * Service details data.
12328
+ * The service details.
12256
12329
  */
12257
12330
  data?: Service;
12258
12331
  /**
12259
12332
  * @remarks
12260
- * Response message.
12333
+ * The returned message.
12261
12334
  *
12262
12335
  * @example
12263
12336
  * success
@@ -12265,7 +12338,7 @@ export class GetServiceResponseBody extends $dara.Model {
12265
12338
  message?: string;
12266
12339
  /**
12267
12340
  * @remarks
12268
- * Request ID.
12341
+ * The request ID.
12269
12342
  *
12270
12343
  * @example
12271
12344
  * 8FA9BB94-915B-5299-A694-49FCC7F5DD00
@@ -12478,15 +12551,15 @@ export class GetTraceConfigResponse extends $dara.Model {
12478
12551
  export class ImportHttpApiRequest extends $dara.Model {
12479
12552
  /**
12480
12553
  * @remarks
12481
- * The description of the imported API. If not provided, it will be extracted from the API definition. The length is limited to 255 bytes.
12554
+ * The API description, which cannot exceed 255 bytes in length. If you do not specify a description, a description is extracted from the definition file.
12482
12555
  *
12483
12556
  * @example
12484
- * 测试专用API
12557
+ * API for testing
12485
12558
  */
12486
12559
  description?: string;
12487
12560
  /**
12488
12561
  * @remarks
12489
- * Pre-import check. If enabled, only the check will be performed without importing the API.
12562
+ * Specifies whether to perform a dry run. If this parameter is set to true, a dry run is performed without importing the file.
12490
12563
  *
12491
12564
  * @example
12492
12565
  * false
@@ -12494,7 +12567,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12494
12567
  dryRun?: boolean;
12495
12568
  /**
12496
12569
  * @remarks
12497
- * The name of the imported API. If not provided, it will be extracted from the API definition file. If the API name and version configuration already exist, this import will update the existing API definition based on the `strategy` field.
12570
+ * The API name. If you do not specify a name, a name is extracted from the definition file. If a name and a versioning configuration already exist, the existing API definition is updated based on the strategy field.
12498
12571
  *
12499
12572
  * @example
12500
12573
  * import-test
@@ -12502,7 +12575,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12502
12575
  name?: string;
12503
12576
  /**
12504
12577
  * @remarks
12505
- * The ID of the resource group.
12578
+ * [The resource group ID](https://help.aliyun.com/document_detail/151181.html).
12506
12579
  *
12507
12580
  * @example
12508
12581
  * rg-acfm3q4zjh7fkki
@@ -12510,7 +12583,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12510
12583
  resourceGroupId?: string;
12511
12584
  /**
12512
12585
  * @remarks
12513
- * Base64 encoded API definition, supporting OAS2.0 and OAS3.0 specifications, in YAML or JSON format. It has a higher priority than the `specFileUrl` parameter. If the file size exceeds 10MB, please use the `specFileUrl` parameter to transfer.
12586
+ * The Base64-encoded API definition. OAS 2.0 and OAS 3.0 specifications are supported. YAML and JSON formats are supported. This parameter precedes over the specFileUrl parameter. However, if the file size exceeds 10 MB, use the specFileUrl parameter to pass the definition.
12514
12587
  *
12515
12588
  * @example
12516
12589
  * b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo=
@@ -12518,7 +12591,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12518
12591
  specContentBase64?: string;
12519
12592
  /**
12520
12593
  * @remarks
12521
- * Download URL for the API definition file, which must be accessible from the public network or via an internal OSS download address within the same region. The file URL must have download permissions. For non-publicly readable OSS file links, refer to the documentation at https://help.aliyun.com/zh/oss/user-guide/how-to-obtain-the-url-of-a-single-object-or-the-urls-of-multiple-objects, and provide a URL with download permissions. Currently, only API definition files stored on OSS are supported.
12594
+ * The download URL of the API definition file. You can download the file over the Internet or by using an Object Storage Service (OSS) internal download URL that belongs to the current region. You must obtain the required permissions to download the file. For OSS URLs that are not publicly readable, refer to https://help.aliyun.com/zh/oss/user-guide/how-to-obtain-the-url-of-a-single-object-or-the-urls-of-multiple-objects to specify URLs that provide download permissions. Currently, only OSS URLs are supported.
12522
12595
  *
12523
12596
  * @example
12524
12597
  * https://my-bucket.oss-cn-hangzhou.aliyuncs.com/my-api/api.yaml
@@ -12526,16 +12599,16 @@ export class ImportHttpApiRequest extends $dara.Model {
12526
12599
  specFileUrl?: string;
12527
12600
  /**
12528
12601
  * @remarks
12529
- * The oss config info.
12602
+ * The OSS information.
12530
12603
  */
12531
12604
  specOssConfig?: ImportHttpApiRequestSpecOssConfig;
12532
12605
  /**
12533
12606
  * @remarks
12534
- * When the imported API name and version management match an existing API, you need to specify an update strategy.
12535
- * - SpecOnly: Completely based on the imported file.
12536
- * - SpecFirst: Prioritize the imported file, add new interfaces and update existing ones, while keeping interfaces not mentioned in the file unchanged.
12537
- * - ExistFirst: Prioritize the existing API, only add new interfaces without updating existing ones.
12538
- * If not specified, the default strategy is ExistFirst.
12607
+ * The update policy when the API to be imported has the same version and name as an existing one. Valid values:
12608
+ *
12609
+ * * SpectOnly: All configurations in the file take effect.
12610
+ * * SpecFirst: The file takes precedence. New APIs are created and existing ones are updated. APIs not included in the file remain unchanged.
12611
+ * * ExistFirst (default): The existing APIs take precedence. New APIs are created but existing ones remain unchanged.
12539
12612
  *
12540
12613
  * @example
12541
12614
  * ExistFirst
@@ -12543,7 +12616,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12543
12616
  strategy?: string;
12544
12617
  /**
12545
12618
  * @remarks
12546
- * If this field is specified, this import will update the specified API instead of importing or searching for an existing API based on the API name and version management configuration. The target API must be of REST type.
12619
+ * The API to be updated. If this parameter is specified, this import updates only the specified API. New APIs are not created and unspecified existing APIs are not updated. Only REST APIs can be specified.
12547
12620
  *
12548
12621
  * @example
12549
12622
  * api-xxxx
@@ -12551,7 +12624,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12551
12624
  targetHttpApiId?: string;
12552
12625
  /**
12553
12626
  * @remarks
12554
- * API versioning configuration. If versioning is enabled, and the version number and API name match an existing API, this import will be treated as an update. If versioning is not enabled, and the API name matches an existing API, this import will also be treated as an update.
12627
+ * Version configuration.
12555
12628
  */
12556
12629
  versionConfig?: HttpApiVersionConfig;
12557
12630
  static names(): { [key: string]: string } {
@@ -12602,7 +12675,7 @@ export class ImportHttpApiRequest extends $dara.Model {
12602
12675
  export class ImportHttpApiResponseBody extends $dara.Model {
12603
12676
  /**
12604
12677
  * @remarks
12605
- * Response status code.
12678
+ * The status code.
12606
12679
  *
12607
12680
  * @example
12608
12681
  * Ok
@@ -12610,12 +12683,12 @@ export class ImportHttpApiResponseBody extends $dara.Model {
12610
12683
  code?: string;
12611
12684
  /**
12612
12685
  * @remarks
12613
- * API information.
12686
+ * The API information.
12614
12687
  */
12615
12688
  data?: ImportHttpApiResponseBodyData;
12616
12689
  /**
12617
12690
  * @remarks
12618
- * Response message.
12691
+ * The returned message.
12619
12692
  *
12620
12693
  * @example
12621
12694
  * success
@@ -12623,7 +12696,7 @@ export class ImportHttpApiResponseBody extends $dara.Model {
12623
12696
  message?: string;
12624
12697
  /**
12625
12698
  * @remarks
12626
- * Request ID.
12699
+ * The request ID.
12627
12700
  *
12628
12701
  * @example
12629
12702
  * CE857A85-251D-5018-8103-A38957D71E20
@@ -12697,7 +12770,7 @@ export class ImportHttpApiResponse extends $dara.Model {
12697
12770
  export class ListDomainsRequest extends $dara.Model {
12698
12771
  /**
12699
12772
  * @remarks
12700
- * Gateway Id.
12773
+ * The instance ID.
12701
12774
  *
12702
12775
  * @example
12703
12776
  * gw-xxx
@@ -12705,7 +12778,7 @@ export class ListDomainsRequest extends $dara.Model {
12705
12778
  gatewayId?: string;
12706
12779
  /**
12707
12780
  * @remarks
12708
- * Domain name, fuzzy search.
12781
+ * The domain name keyword for fuzzy search.
12709
12782
  *
12710
12783
  * @example
12711
12784
  * test
@@ -12713,7 +12786,7 @@ export class ListDomainsRequest extends $dara.Model {
12713
12786
  nameLike?: string;
12714
12787
  /**
12715
12788
  * @remarks
12716
- * Page number, default is 1.
12789
+ * The page number of the page to return. Default value: 1.
12717
12790
  *
12718
12791
  * @example
12719
12792
  * 1
@@ -12721,7 +12794,7 @@ export class ListDomainsRequest extends $dara.Model {
12721
12794
  pageNumber?: number;
12722
12795
  /**
12723
12796
  * @remarks
12724
- * Number of items per page, default is 10.
12797
+ * The number of entries per page. Default value: 10.
12725
12798
  *
12726
12799
  * @example
12727
12800
  * 10
@@ -12729,7 +12802,7 @@ export class ListDomainsRequest extends $dara.Model {
12729
12802
  pageSize?: number;
12730
12803
  /**
12731
12804
  * @remarks
12732
- * Resource group ID.
12805
+ * The ID of the resource group.
12733
12806
  *
12734
12807
  * @example
12735
12808
  * rg-ahr5uil8raz0rq3b
@@ -12767,7 +12840,7 @@ export class ListDomainsRequest extends $dara.Model {
12767
12840
  export class ListDomainsResponseBody extends $dara.Model {
12768
12841
  /**
12769
12842
  * @remarks
12770
- * Response code.
12843
+ * The status code returned.
12771
12844
  *
12772
12845
  * @example
12773
12846
  * Ok
@@ -12775,12 +12848,12 @@ export class ListDomainsResponseBody extends $dara.Model {
12775
12848
  code?: string;
12776
12849
  /**
12777
12850
  * @remarks
12778
- * Response data.
12851
+ * The response data.
12779
12852
  */
12780
12853
  data?: ListDomainsResponseBodyData;
12781
12854
  /**
12782
12855
  * @remarks
12783
- * Response message.
12856
+ * The message returned.
12784
12857
  *
12785
12858
  * @example
12786
12859
  * success
@@ -12788,7 +12861,7 @@ export class ListDomainsResponseBody extends $dara.Model {
12788
12861
  message?: string;
12789
12862
  /**
12790
12863
  * @remarks
12791
- * Request ID, used for tracing the API call chain.
12864
+ * The request ID, which is used to trace the API call link.
12792
12865
  *
12793
12866
  * @example
12794
12867
  * C61E30D3-579A-5B43-994E-31E02EDC9129
@@ -13047,7 +13120,7 @@ export class ListEnvironmentsResponse extends $dara.Model {
13047
13120
  export class ListGatewaysRequest extends $dara.Model {
13048
13121
  /**
13049
13122
  * @remarks
13050
- * Query exactly by Gateway ID.
13123
+ * The instance ID. If you specify an ID, an exact search is performed.
13051
13124
  *
13052
13125
  * @example
13053
13126
  * gw-cpv4sqdl****
@@ -13055,7 +13128,7 @@ export class ListGatewaysRequest extends $dara.Model {
13055
13128
  gatewayId?: string;
13056
13129
  /**
13057
13130
  * @remarks
13058
- * Keyword, search with full match, case-insensitive.
13131
+ * The search keyword. A full match is performed. The search is case-insensitive.
13059
13132
  *
13060
13133
  * @example
13061
13134
  * dev
@@ -13063,7 +13136,7 @@ export class ListGatewaysRequest extends $dara.Model {
13063
13136
  keyword?: string;
13064
13137
  /**
13065
13138
  * @remarks
13066
- * Query exactly by Gateway name.
13139
+ * The instance name. If you specify a name, an exact search is performed.
13067
13140
  *
13068
13141
  * @example
13069
13142
  * itemcenter-gateway
@@ -13071,7 +13144,7 @@ export class ListGatewaysRequest extends $dara.Model {
13071
13144
  name?: string;
13072
13145
  /**
13073
13146
  * @remarks
13074
- * Page number.
13147
+ * The number of the page to return.
13075
13148
  *
13076
13149
  * @example
13077
13150
  * 1
@@ -13079,7 +13152,7 @@ export class ListGatewaysRequest extends $dara.Model {
13079
13152
  pageNumber?: number;
13080
13153
  /**
13081
13154
  * @remarks
13082
- * Page size.
13155
+ * The number of entries per page.
13083
13156
  *
13084
13157
  * @example
13085
13158
  * 10
@@ -13087,7 +13160,7 @@ export class ListGatewaysRequest extends $dara.Model {
13087
13160
  pageSize?: number;
13088
13161
  /**
13089
13162
  * @remarks
13090
- * Resource group ID.
13163
+ * The resource group ID.
13091
13164
  *
13092
13165
  * @example
13093
13166
  * rg-aekz3wes3hnre5a
@@ -13095,7 +13168,7 @@ export class ListGatewaysRequest extends $dara.Model {
13095
13168
  resourceGroupId?: string;
13096
13169
  /**
13097
13170
  * @remarks
13098
- * Filter list by tags
13171
+ * The tags that you want to use for the search.
13099
13172
  */
13100
13173
  tag?: ListGatewaysRequestTag[];
13101
13174
  static names(): { [key: string]: string } {
@@ -13137,7 +13210,7 @@ export class ListGatewaysRequest extends $dara.Model {
13137
13210
  export class ListGatewaysShrinkRequest extends $dara.Model {
13138
13211
  /**
13139
13212
  * @remarks
13140
- * Query exactly by Gateway ID.
13213
+ * The instance ID. If you specify an ID, an exact search is performed.
13141
13214
  *
13142
13215
  * @example
13143
13216
  * gw-cpv4sqdl****
@@ -13145,7 +13218,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13145
13218
  gatewayId?: string;
13146
13219
  /**
13147
13220
  * @remarks
13148
- * Keyword, search with full match, case-insensitive.
13221
+ * The search keyword. A full match is performed. The search is case-insensitive.
13149
13222
  *
13150
13223
  * @example
13151
13224
  * dev
@@ -13153,7 +13226,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13153
13226
  keyword?: string;
13154
13227
  /**
13155
13228
  * @remarks
13156
- * Query exactly by Gateway name.
13229
+ * The instance name. If you specify a name, an exact search is performed.
13157
13230
  *
13158
13231
  * @example
13159
13232
  * itemcenter-gateway
@@ -13161,7 +13234,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13161
13234
  name?: string;
13162
13235
  /**
13163
13236
  * @remarks
13164
- * Page number.
13237
+ * The number of the page to return.
13165
13238
  *
13166
13239
  * @example
13167
13240
  * 1
@@ -13169,7 +13242,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13169
13242
  pageNumber?: number;
13170
13243
  /**
13171
13244
  * @remarks
13172
- * Page size.
13245
+ * The number of entries per page.
13173
13246
  *
13174
13247
  * @example
13175
13248
  * 10
@@ -13177,7 +13250,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13177
13250
  pageSize?: number;
13178
13251
  /**
13179
13252
  * @remarks
13180
- * Resource group ID.
13253
+ * The resource group ID.
13181
13254
  *
13182
13255
  * @example
13183
13256
  * rg-aekz3wes3hnre5a
@@ -13185,7 +13258,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13185
13258
  resourceGroupId?: string;
13186
13259
  /**
13187
13260
  * @remarks
13188
- * Filter list by tags
13261
+ * The tags that you want to use for the search.
13189
13262
  */
13190
13263
  tagShrink?: string;
13191
13264
  static names(): { [key: string]: string } {
@@ -13224,7 +13297,7 @@ export class ListGatewaysShrinkRequest extends $dara.Model {
13224
13297
  export class ListGatewaysResponseBody extends $dara.Model {
13225
13298
  /**
13226
13299
  * @remarks
13227
- * Response status code.
13300
+ * The status code.
13228
13301
  *
13229
13302
  * @example
13230
13303
  * Ok
@@ -13232,12 +13305,12 @@ export class ListGatewaysResponseBody extends $dara.Model {
13232
13305
  code?: string;
13233
13306
  /**
13234
13307
  * @remarks
13235
- * Result of gateway list query.
13308
+ * The instances.
13236
13309
  */
13237
13310
  data?: ListGatewaysResponseBodyData;
13238
13311
  /**
13239
13312
  * @remarks
13240
- * Response message.
13313
+ * The returned message.
13241
13314
  *
13242
13315
  * @example
13243
13316
  * success
@@ -13245,7 +13318,7 @@ export class ListGatewaysResponseBody extends $dara.Model {
13245
13318
  message?: string;
13246
13319
  /**
13247
13320
  * @remarks
13248
- * Request ID.
13321
+ * The request ID.
13249
13322
  *
13250
13323
  * @example
13251
13324
  * 5B626361-070A-56A7-B127-ADAC8F3655DB
@@ -13534,7 +13607,7 @@ export class ListHttpApiOperationsResponse extends $dara.Model {
13534
13607
  export class ListHttpApiRoutesRequest extends $dara.Model {
13535
13608
  /**
13536
13609
  * @remarks
13537
- * Filter the interface list based on a specific consumer authorization rule ID. The interface list in the response will only include authorized interfaces.
13610
+ * The string that is used to filter routes based on consumer authentication rules. Only authorized APIs are returned.
13538
13611
  *
13539
13612
  * @example
13540
13613
  * cas-xxx
@@ -13542,7 +13615,17 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13542
13615
  consumerAuthorizationRuleId?: string;
13543
13616
  /**
13544
13617
  * @remarks
13545
- * Deployment status of the route.
13618
+ * The deployment state of the route.
13619
+ *
13620
+ * Enumerated values:
13621
+ *
13622
+ * * Deploying: The route is being deployed.
13623
+ * * DeployedWithChanges: The route is deployed and modified.
13624
+ * * Undeploying: The route is being undeployed.
13625
+ * * NotDeployed: The route is not deployed.
13626
+ * * Deployed: The route is deployed.
13627
+ * * UndeployFailed: The route failed to be undeployed.
13628
+ * * DeployFailed: The route failed to be deployed.
13546
13629
  *
13547
13630
  * @example
13548
13631
  * NotDeployed
@@ -13550,7 +13633,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13550
13633
  deployStatuses?: string;
13551
13634
  /**
13552
13635
  * @remarks
13553
- * Filter route information by domain ID.
13636
+ * Specifies to filter routes by domain ID.
13554
13637
  *
13555
13638
  * @example
13556
13639
  * d-xxx
@@ -13558,7 +13641,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13558
13641
  domainId?: string;
13559
13642
  /**
13560
13643
  * @remarks
13561
- * Environment ID.
13644
+ * The environment ID.
13562
13645
  *
13563
13646
  * @example
13564
13647
  * env-cpqnr6tlhtgubc***
@@ -13566,7 +13649,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13566
13649
  environmentId?: string;
13567
13650
  /**
13568
13651
  * @remarks
13569
- * Cloud-native API Gateway ID.
13652
+ * The ID of the Cloud-native API Gateway instance.
13570
13653
  *
13571
13654
  * @example
13572
13655
  * gw-cpv4sqdl****
@@ -13574,7 +13657,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13574
13657
  gatewayId?: string;
13575
13658
  /**
13576
13659
  * @remarks
13577
- * Route name.
13660
+ * The route name.
13578
13661
  *
13579
13662
  * @example
13580
13663
  * itemcenter-gateway
@@ -13582,7 +13665,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13582
13665
  name?: string;
13583
13666
  /**
13584
13667
  * @remarks
13585
- * Fuzzy search by route name.
13668
+ * The route name keyword for a fuzzy search.
13586
13669
  *
13587
13670
  * @example
13588
13671
  * item
@@ -13590,7 +13673,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13590
13673
  nameLike?: string;
13591
13674
  /**
13592
13675
  * @remarks
13593
- * Page number, starting from 1. Default is 1 if not specified.
13676
+ * The page number of the page to return. Pages start from page 1. Default value: 1.
13594
13677
  *
13595
13678
  * @example
13596
13679
  * 1
@@ -13598,7 +13681,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13598
13681
  pageNumber?: number;
13599
13682
  /**
13600
13683
  * @remarks
13601
- * Page size, valid range [1, 100]. Default is 10 if not specified.
13684
+ * The number of entries per page. Valid values: 1 to 100. Default value: 10.
13602
13685
  *
13603
13686
  * @example
13604
13687
  * 10
@@ -13606,7 +13689,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13606
13689
  pageSize?: number;
13607
13690
  /**
13608
13691
  * @remarks
13609
- * Fuzzy search by route path.
13692
+ * The route path keyword for a fuzzy search.
13610
13693
  *
13611
13694
  * @example
13612
13695
  * /v1
@@ -13614,7 +13697,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13614
13697
  pathLike?: string;
13615
13698
  /**
13616
13699
  * @remarks
13617
- * The response includes consumer authorization information.
13700
+ * The consumer authorization information in the response.
13618
13701
  *
13619
13702
  * @example
13620
13703
  * true
@@ -13622,7 +13705,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13622
13705
  withAuthPolicyInfo?: boolean;
13623
13706
  /**
13624
13707
  * @remarks
13625
- * Each route information in the response carries the list of authorization rules for the specified consumer ID.
13708
+ * The authentication rules of the specified consumer in each route returned.
13626
13709
  *
13627
13710
  * @example
13628
13711
  * cs-xxx
@@ -13630,7 +13713,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13630
13713
  withConsumerInfoById?: string;
13631
13714
  /**
13632
13715
  * @remarks
13633
- * Each route information in the response carries the attachment information for the specified plugin ID.
13716
+ * The mounting information of the specified plug-in in each route returned.
13634
13717
  *
13635
13718
  * @example
13636
13719
  * pl-xxx
@@ -13684,7 +13767,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
13684
13767
  export class ListHttpApiRoutesResponseBody extends $dara.Model {
13685
13768
  /**
13686
13769
  * @remarks
13687
- * Response status code.
13770
+ * The status code.
13688
13771
  *
13689
13772
  * @example
13690
13773
  * Ok
@@ -13692,12 +13775,12 @@ export class ListHttpApiRoutesResponseBody extends $dara.Model {
13692
13775
  code?: string;
13693
13776
  /**
13694
13777
  * @remarks
13695
- * Response data.
13778
+ * The response parameters.
13696
13779
  */
13697
13780
  data?: ListHttpApiRoutesResponseBodyData;
13698
13781
  /**
13699
13782
  * @remarks
13700
- * Response message.
13783
+ * The returned message.
13701
13784
  *
13702
13785
  * @example
13703
13786
  * success
@@ -13705,7 +13788,7 @@ export class ListHttpApiRoutesResponseBody extends $dara.Model {
13705
13788
  message?: string;
13706
13789
  /**
13707
13790
  * @remarks
13708
- * Request ID.
13791
+ * The request ID.
13709
13792
  *
13710
13793
  * @example
13711
13794
  * CBEEB8C1-108E-50F0-9BEA-DED79553C309
@@ -13779,7 +13862,7 @@ export class ListHttpApiRoutesResponse extends $dara.Model {
13779
13862
  export class ListHttpApisRequest extends $dara.Model {
13780
13863
  /**
13781
13864
  * @remarks
13782
- * Cloud-native API Gateway ID.
13865
+ * The ID of the Cloud-native API Gateway instance.
13783
13866
  *
13784
13867
  * @example
13785
13868
  * gw-cq2avtllh****
@@ -13787,7 +13870,7 @@ export class ListHttpApisRequest extends $dara.Model {
13787
13870
  gatewayId?: string;
13788
13871
  /**
13789
13872
  * @remarks
13790
- * Search keyword, supports fuzzy search by API name or exact search by API ID.
13873
+ * The search keyword. You can fuzzy-search by API name or exact-search by API ID.
13791
13874
  *
13792
13875
  * @example
13793
13876
  * test-
@@ -13795,7 +13878,7 @@ export class ListHttpApisRequest extends $dara.Model {
13795
13878
  keyword?: string;
13796
13879
  /**
13797
13880
  * @remarks
13798
- * Exact search by name.
13881
+ * The API name that is used for the search. In this case, exact search is performed.
13799
13882
  *
13800
13883
  * @example
13801
13884
  * login
@@ -13803,7 +13886,7 @@ export class ListHttpApisRequest extends $dara.Model {
13803
13886
  name?: string;
13804
13887
  /**
13805
13888
  * @remarks
13806
- * Page number, starting from 1, default is 1 if not specified.
13889
+ * The page number of the page to return. Pages start from page 1. Default value: 1.
13807
13890
  *
13808
13891
  * @example
13809
13892
  * 1
@@ -13811,7 +13894,7 @@ export class ListHttpApisRequest extends $dara.Model {
13811
13894
  pageNumber?: number;
13812
13895
  /**
13813
13896
  * @remarks
13814
- * Page size, valid range [1, 100], default is 10 if not specified.
13897
+ * The number of entries per page. Valid values: 1 to 100. Default value: 10.
13815
13898
  *
13816
13899
  * @example
13817
13900
  * 10
@@ -13819,7 +13902,7 @@ export class ListHttpApisRequest extends $dara.Model {
13819
13902
  pageSize?: number;
13820
13903
  /**
13821
13904
  * @remarks
13822
- * Resource group ID.
13905
+ * The resource group ID.
13823
13906
  *
13824
13907
  * @example
13825
13908
  * rg-ahr5uil8raz0rq3b
@@ -13827,19 +13910,21 @@ export class ListHttpApisRequest extends $dara.Model {
13827
13910
  resourceGroupId?: string;
13828
13911
  /**
13829
13912
  * @remarks
13830
- * Type of HTTP API. Multiple types can be passed, separated by ",".
13831
- * - Http
13832
- * - Rest
13833
- * - WebSocket
13834
- * - HttpIngress
13913
+ * The API type. You can specify multiple types and separate them with a comma (,).
13914
+ *
13915
+ * * Http
13916
+ * * Rest
13917
+ * * WebSocket
13918
+ * * HttpIngress
13835
13919
  *
13836
13920
  * @example
13837
13921
  * Http,Rest
13838
13922
  */
13839
13923
  types?: string;
13924
+ withAPIsPublishedToEnvironment?: boolean;
13840
13925
  /**
13841
13926
  * @remarks
13842
- * Each API information in the response carries consumer authentication policy information for the specified environment ID.
13927
+ * The consumer authentication policy in the specified environment in each returned API.
13843
13928
  *
13844
13929
  * @example
13845
13930
  * env-xxx
@@ -13847,7 +13932,7 @@ export class ListHttpApisRequest extends $dara.Model {
13847
13932
  withAuthPolicyInEnvironmentId?: string;
13848
13933
  /**
13849
13934
  * @remarks
13850
- * Whether the authentication policy is enabled.
13935
+ * Specifies whether authentication is enabled.
13851
13936
  *
13852
13937
  * @example
13853
13938
  * true
@@ -13855,7 +13940,7 @@ export class ListHttpApisRequest extends $dara.Model {
13855
13940
  withAuthPolicyList?: boolean;
13856
13941
  /**
13857
13942
  * @remarks
13858
- * Each API information in the response carries a list of authorization rules for the specified consumer ID.
13943
+ * The authorization rules of the specified consumer in each returned API.
13859
13944
  *
13860
13945
  * @example
13861
13946
  * cs-xxx
@@ -13863,7 +13948,7 @@ export class ListHttpApisRequest extends $dara.Model {
13863
13948
  withConsumerInfoById?: string;
13864
13949
  /**
13865
13950
  * @remarks
13866
- * Environment information
13951
+ * The environment information.
13867
13952
  *
13868
13953
  * @example
13869
13954
  * true
@@ -13871,7 +13956,7 @@ export class ListHttpApisRequest extends $dara.Model {
13871
13956
  withEnvironmentInfo?: boolean;
13872
13957
  /**
13873
13958
  * @remarks
13874
- * Environment ID
13959
+ * The environment ID.
13875
13960
  *
13876
13961
  * @example
13877
13962
  * env-ctovu5mm1hksb4q8ln40
@@ -13879,7 +13964,7 @@ export class ListHttpApisRequest extends $dara.Model {
13879
13964
  withEnvironmentInfoById?: string;
13880
13965
  /**
13881
13966
  * @remarks
13882
- * Ingress information
13967
+ * The Ingress information.
13883
13968
  *
13884
13969
  * @example
13885
13970
  * false
@@ -13887,12 +13972,13 @@ export class ListHttpApisRequest extends $dara.Model {
13887
13972
  withIngressInfo?: boolean;
13888
13973
  /**
13889
13974
  * @remarks
13890
- * Plugin ID, used to get plugin release information based on this ID.
13975
+ * The plug-in ID. You can use the returned value of this parameter to query the plug-in.
13891
13976
  *
13892
13977
  * @example
13893
13978
  * pl-ct9qn3um1hktue8dqol0
13894
13979
  */
13895
13980
  withPluginAttachmentByPluginId?: string;
13981
+ withPolicyConfigs?: boolean;
13896
13982
  static names(): { [key: string]: string } {
13897
13983
  return {
13898
13984
  gatewayId: 'gatewayId',
@@ -13902,6 +13988,7 @@ export class ListHttpApisRequest extends $dara.Model {
13902
13988
  pageSize: 'pageSize',
13903
13989
  resourceGroupId: 'resourceGroupId',
13904
13990
  types: 'types',
13991
+ withAPIsPublishedToEnvironment: 'withAPIsPublishedToEnvironment',
13905
13992
  withAuthPolicyInEnvironmentId: 'withAuthPolicyInEnvironmentId',
13906
13993
  withAuthPolicyList: 'withAuthPolicyList',
13907
13994
  withConsumerInfoById: 'withConsumerInfoById',
@@ -13909,6 +13996,7 @@ export class ListHttpApisRequest extends $dara.Model {
13909
13996
  withEnvironmentInfoById: 'withEnvironmentInfoById',
13910
13997
  withIngressInfo: 'withIngressInfo',
13911
13998
  withPluginAttachmentByPluginId: 'withPluginAttachmentByPluginId',
13999
+ withPolicyConfigs: 'withPolicyConfigs',
13912
14000
  };
13913
14001
  }
13914
14002
 
@@ -13921,6 +14009,7 @@ export class ListHttpApisRequest extends $dara.Model {
13921
14009
  pageSize: 'number',
13922
14010
  resourceGroupId: 'string',
13923
14011
  types: 'string',
14012
+ withAPIsPublishedToEnvironment: 'boolean',
13924
14013
  withAuthPolicyInEnvironmentId: 'string',
13925
14014
  withAuthPolicyList: 'boolean',
13926
14015
  withConsumerInfoById: 'string',
@@ -13928,6 +14017,7 @@ export class ListHttpApisRequest extends $dara.Model {
13928
14017
  withEnvironmentInfoById: 'string',
13929
14018
  withIngressInfo: 'boolean',
13930
14019
  withPluginAttachmentByPluginId: 'string',
14020
+ withPolicyConfigs: 'boolean',
13931
14021
  };
13932
14022
  }
13933
14023
 
@@ -13943,7 +14033,7 @@ export class ListHttpApisRequest extends $dara.Model {
13943
14033
  export class ListHttpApisResponseBody extends $dara.Model {
13944
14034
  /**
13945
14035
  * @remarks
13946
- * Response status code.
14036
+ * The status code.
13947
14037
  *
13948
14038
  * @example
13949
14039
  * Ok
@@ -13951,12 +14041,12 @@ export class ListHttpApisResponseBody extends $dara.Model {
13951
14041
  code?: string;
13952
14042
  /**
13953
14043
  * @remarks
13954
- * API list.
14044
+ * The APIs.
13955
14045
  */
13956
14046
  data?: ListHttpApisResponseBodyData;
13957
14047
  /**
13958
14048
  * @remarks
13959
- * Response message.
14049
+ * The returned message.
13960
14050
  *
13961
14051
  * @example
13962
14052
  * success
@@ -13964,7 +14054,7 @@ export class ListHttpApisResponseBody extends $dara.Model {
13964
14054
  message?: string;
13965
14055
  /**
13966
14056
  * @remarks
13967
- * Request ID.
14057
+ * The request ID.
13968
14058
  *
13969
14059
  * @example
13970
14060
  * 585657D2-1C20-5B8A-AF17-D727C6490BE4
@@ -14214,7 +14304,7 @@ export class ListPolicyClassesResponse extends $dara.Model {
14214
14304
  export class ListServicesRequest extends $dara.Model {
14215
14305
  /**
14216
14306
  * @remarks
14217
- * Cloud-native API Gateway ID.
14307
+ * The ID of the Cloud-native API Gateway instance.
14218
14308
  *
14219
14309
  * @example
14220
14310
  * gw-cpv4sqdl*****
@@ -14222,7 +14312,7 @@ export class ListServicesRequest extends $dara.Model {
14222
14312
  gatewayId?: string;
14223
14313
  /**
14224
14314
  * @remarks
14225
- * Exact query by service name.
14315
+ * The service name.
14226
14316
  *
14227
14317
  * @example
14228
14318
  * user-service
@@ -14230,7 +14320,7 @@ export class ListServicesRequest extends $dara.Model {
14230
14320
  name?: string;
14231
14321
  /**
14232
14322
  * @remarks
14233
- * Page number, starting from 1. Default is 1 if not specified.
14323
+ * The page number to return. Pages start from page 1. Default value: 1.
14234
14324
  *
14235
14325
  * @example
14236
14326
  * 1
@@ -14238,7 +14328,7 @@ export class ListServicesRequest extends $dara.Model {
14238
14328
  pageNumber?: number;
14239
14329
  /**
14240
14330
  * @remarks
14241
- * Page size, valid range [1, 100]. Default is 10 if not specified.
14331
+ * The number of entries per page. Valid values: 1 to 100. Default value: 10.
14242
14332
  *
14243
14333
  * @example
14244
14334
  * 10
@@ -14246,7 +14336,7 @@ export class ListServicesRequest extends $dara.Model {
14246
14336
  pageSize?: number;
14247
14337
  /**
14248
14338
  * @remarks
14249
- * Resource group ID.
14339
+ * The resource group ID.
14250
14340
  *
14251
14341
  * @example
14252
14342
  * rg-acfmxxe5rc6cvla
@@ -14254,17 +14344,27 @@ export class ListServicesRequest extends $dara.Model {
14254
14344
  resourceGroupId?: string;
14255
14345
  /**
14256
14346
  * @remarks
14257
- * Query by service source type. Service sources:
14258
- * - MSE_NACOS: Services from MSE Nacos.
14259
- * - K8S: Services from K8S clusters in container services.
14260
- * - FC3: Services from function computing.
14261
- * - VIP: Services from a fixed address.
14262
- * - DNS: Services from a domain name.
14347
+ * The service source. Valid values:
14348
+ *
14349
+ * * MSE_NACOS: a service in an MSE Nacos instance
14350
+ * * K8S: a service in a Kubernetes (K8s) cluster in Container Service for Kubernetes (ACK)
14351
+ * * FC3: a service in Function Compute
14352
+ * * VIP: a fixed address
14353
+ * * DNS: a domain name
14354
+ *
14355
+ * Enumerated values:
14356
+ *
14357
+ * * K8S
14358
+ * * FC3
14359
+ * * DNS
14360
+ * * VIP
14361
+ * * MSE_NACOS
14263
14362
  *
14264
14363
  * @example
14265
14364
  * MSE_NACOS
14266
14365
  */
14267
14366
  sourceType?: string;
14367
+ sourceTypes?: string;
14268
14368
  static names(): { [key: string]: string } {
14269
14369
  return {
14270
14370
  gatewayId: 'gatewayId',
@@ -14273,6 +14373,7 @@ export class ListServicesRequest extends $dara.Model {
14273
14373
  pageSize: 'pageSize',
14274
14374
  resourceGroupId: 'resourceGroupId',
14275
14375
  sourceType: 'sourceType',
14376
+ sourceTypes: 'sourceTypes',
14276
14377
  };
14277
14378
  }
14278
14379
 
@@ -14284,6 +14385,7 @@ export class ListServicesRequest extends $dara.Model {
14284
14385
  pageSize: 'number',
14285
14386
  resourceGroupId: 'string',
14286
14387
  sourceType: 'string',
14388
+ sourceTypes: 'string',
14287
14389
  };
14288
14390
  }
14289
14391
 
@@ -14299,7 +14401,7 @@ export class ListServicesRequest extends $dara.Model {
14299
14401
  export class ListServicesResponseBody extends $dara.Model {
14300
14402
  /**
14301
14403
  * @remarks
14302
- * Response status code.
14404
+ * The status code.
14303
14405
  *
14304
14406
  * @example
14305
14407
  * Ok
@@ -14307,12 +14409,12 @@ export class ListServicesResponseBody extends $dara.Model {
14307
14409
  code?: string;
14308
14410
  /**
14309
14411
  * @remarks
14310
- * Response data.
14412
+ * The response parameters.
14311
14413
  */
14312
14414
  data?: ListServicesResponseBodyData;
14313
14415
  /**
14314
14416
  * @remarks
14315
- * Response message.
14417
+ * The returned message.
14316
14418
  *
14317
14419
  * @example
14318
14420
  * success
@@ -14320,7 +14422,7 @@ export class ListServicesResponseBody extends $dara.Model {
14320
14422
  message?: string;
14321
14423
  /**
14322
14424
  * @remarks
14323
- * Request ID.
14425
+ * The request ID.
14324
14426
  *
14325
14427
  * @example
14326
14428
  * 585657D2-1C20-5B8A-AF17-D727C6490BE4
@@ -14728,11 +14830,17 @@ export class RestartGatewayResponse extends $dara.Model {
14728
14830
 
14729
14831
  export class UndeployHttpApiRequest extends $dara.Model {
14730
14832
  /**
14833
+ * @remarks
14834
+ * The environment ID.
14835
+ *
14731
14836
  * @example
14732
14837
  * env-cqsmtellhtgvo***
14733
14838
  */
14734
14839
  environmentId?: string;
14735
14840
  /**
14841
+ * @remarks
14842
+ * Route ID. This must be provided when publishing the route of an HTTP API.
14843
+ *
14736
14844
  * @example
14737
14845
  * hr-cr82undlhtgrle***
14738
14846
  */
@@ -14762,16 +14870,25 @@ export class UndeployHttpApiRequest extends $dara.Model {
14762
14870
 
14763
14871
  export class UndeployHttpApiResponseBody extends $dara.Model {
14764
14872
  /**
14873
+ * @remarks
14874
+ * Response code.
14875
+ *
14765
14876
  * @example
14766
14877
  * Ok
14767
14878
  */
14768
14879
  code?: string;
14769
14880
  /**
14881
+ * @remarks
14882
+ * Response message.
14883
+ *
14770
14884
  * @example
14771
14885
  * success
14772
14886
  */
14773
14887
  message?: string;
14774
14888
  /**
14889
+ * @remarks
14890
+ * Request ID.
14891
+ *
14775
14892
  * @example
14776
14893
  * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
14777
14894
  */
@@ -14839,7 +14956,7 @@ export class UndeployHttpApiResponse extends $dara.Model {
14839
14956
  export class UpdateDomainRequest extends $dara.Model {
14840
14957
  /**
14841
14958
  * @remarks
14842
- * CA certificate identifier
14959
+ * The CA certificate ID.
14843
14960
  *
14844
14961
  * @example
14845
14962
  * 1ef1da5f-38ed-69b3-****-037781890265
@@ -14847,7 +14964,7 @@ export class UpdateDomainRequest extends $dara.Model {
14847
14964
  caCertIdentifier?: string;
14848
14965
  /**
14849
14966
  * @remarks
14850
- * Certificate identifier
14967
+ * The certificate ID.
14851
14968
  *
14852
14969
  * @example
14853
14970
  * 1ef1da5f-38ed-69b3-****-037781890265
@@ -14855,7 +14972,7 @@ export class UpdateDomainRequest extends $dara.Model {
14855
14972
  certIdentifier?: string;
14856
14973
  /**
14857
14974
  * @remarks
14858
- * Client CA Certificate
14975
+ * The client CA certificate.
14859
14976
  *
14860
14977
  * @example
14861
14978
  * -----BEGIN CERTIFICATE-----
@@ -14867,7 +14984,7 @@ export class UpdateDomainRequest extends $dara.Model {
14867
14984
  clientCACert?: string;
14868
14985
  /**
14869
14986
  * @remarks
14870
- * Set the HTTPS protocol type, whether to enable forced HTTPS redirection.
14987
+ * Specifies whether to enable HTTPS redirection. If protocol is set to HTTPS, forceHttps is required.
14871
14988
  *
14872
14989
  * @example
14873
14990
  * false
@@ -14875,7 +14992,13 @@ export class UpdateDomainRequest extends $dara.Model {
14875
14992
  forceHttps?: boolean;
14876
14993
  /**
14877
14994
  * @remarks
14878
- * HTTP/2 settings.
14995
+ * The HTTP/2 configuration.
14996
+ *
14997
+ * Enumerated values:
14998
+ *
14999
+ * * GlobalConfig
15000
+ * * Close
15001
+ * * Open
14879
15002
  *
14880
15003
  * @example
14881
15004
  * Open
@@ -14883,15 +15006,15 @@ export class UpdateDomainRequest extends $dara.Model {
14883
15006
  http2Option?: string;
14884
15007
  /**
14885
15008
  * @remarks
14886
- * Whether to enable mTLS mutual authentication
15009
+ * Specifies whether to enable mutual TLS (mTLS) authentication.
14887
15010
  */
14888
15011
  mTLSEnabled?: boolean;
14889
15012
  /**
14890
15013
  * @remarks
14891
- * The protocol type supported by the domain.
15014
+ * The protocol type to be supported by the domain name. Valid values:
14892
15015
  *
14893
- * - HTTP: Supports only HTTP protocol.
14894
- * - HTTPS: Supports only HTTPS protocol.
15016
+ * * HTTP
15017
+ * * HTTPS
14895
15018
  *
14896
15019
  * This parameter is required.
14897
15020
  *
@@ -14901,12 +15024,12 @@ export class UpdateDomainRequest extends $dara.Model {
14901
15024
  protocol?: string;
14902
15025
  /**
14903
15026
  * @remarks
14904
- * TLS Cipher Suite Configuration.
15027
+ * The cipher suite configuration.
14905
15028
  */
14906
15029
  tlsCipherSuitesConfig?: TlsCipherSuitesConfig;
14907
15030
  /**
14908
15031
  * @remarks
14909
- * Maximum TLS protocol version, supports up to TLS 1.3.
15032
+ * The maximum TLS version. Up to TLS 1.3 is supported.
14910
15033
  *
14911
15034
  * @example
14912
15035
  * TLS 1.3
@@ -14914,7 +15037,7 @@ export class UpdateDomainRequest extends $dara.Model {
14914
15037
  tlsMax?: string;
14915
15038
  /**
14916
15039
  * @remarks
14917
- * Minimum TLS protocol version, supports down to TLS 1.0.
15040
+ * The minimum TLS version. Down to TLS 1.0 is supported.
14918
15041
  *
14919
15042
  * @example
14920
15043
  * TLS 1.0
@@ -14965,7 +15088,7 @@ export class UpdateDomainRequest extends $dara.Model {
14965
15088
  export class UpdateDomainResponseBody extends $dara.Model {
14966
15089
  /**
14967
15090
  * @remarks
14968
- * Response code.
15091
+ * The status code.
14969
15092
  *
14970
15093
  * @example
14971
15094
  * Ok
@@ -14973,12 +15096,12 @@ export class UpdateDomainResponseBody extends $dara.Model {
14973
15096
  code?: string;
14974
15097
  /**
14975
15098
  * @remarks
14976
- * The returned data.
15099
+ * The response parameters.
14977
15100
  */
14978
15101
  data?: UpdateDomainResponseBodyData;
14979
15102
  /**
14980
15103
  * @remarks
14981
- * Response message.
15104
+ * The returned message.
14982
15105
  *
14983
15106
  * @example
14984
15107
  * success
@@ -14986,7 +15109,7 @@ export class UpdateDomainResponseBody extends $dara.Model {
14986
15109
  message?: string;
14987
15110
  /**
14988
15111
  * @remarks
14989
- * Request ID, used for tracing the API call chain.
15112
+ * The request ID. You can use this value to trace the API call.
14990
15113
  *
14991
15114
  * @example
14992
15115
  * 4BACB05C-3FE2-588F-9148-700C5C026B74
@@ -15726,12 +15849,12 @@ export class UpdateHttpApiOperationResponse extends $dara.Model {
15726
15849
  export class UpdateHttpApiRouteRequest extends $dara.Model {
15727
15850
  /**
15728
15851
  * @remarks
15729
- * Backend service configuration for the route.
15852
+ * The backend service configurations of the route.
15730
15853
  */
15731
15854
  backendConfig?: UpdateHttpApiRouteRequestBackendConfig;
15732
15855
  /**
15733
15856
  * @remarks
15734
- * Route description.
15857
+ * The route description.
15735
15858
  *
15736
15859
  * @example
15737
15860
  * test route
@@ -15739,12 +15862,12 @@ export class UpdateHttpApiRouteRequest extends $dara.Model {
15739
15862
  description?: string;
15740
15863
  /**
15741
15864
  * @remarks
15742
- * List of domain IDs.
15865
+ * The domain IDs.
15743
15866
  */
15744
15867
  domainIds?: string[];
15745
15868
  /**
15746
15869
  * @remarks
15747
- * Environment ID.
15870
+ * The environment ID.
15748
15871
  *
15749
15872
  * @example
15750
15873
  * env-cquqsollhtgid***
@@ -15752,7 +15875,7 @@ export class UpdateHttpApiRouteRequest extends $dara.Model {
15752
15875
  environmentId?: string;
15753
15876
  /**
15754
15877
  * @remarks
15755
- * Route match rule.
15878
+ * The rules for matching the route.
15756
15879
  */
15757
15880
  match?: HttpRouteMatch;
15758
15881
  static names(): { [key: string]: string } {
@@ -15796,7 +15919,7 @@ export class UpdateHttpApiRouteRequest extends $dara.Model {
15796
15919
  export class UpdateHttpApiRouteResponseBody extends $dara.Model {
15797
15920
  /**
15798
15921
  * @remarks
15799
- * Response status code.
15922
+ * The status code.
15800
15923
  *
15801
15924
  * @example
15802
15925
  * Ok
@@ -15804,7 +15927,7 @@ export class UpdateHttpApiRouteResponseBody extends $dara.Model {
15804
15927
  code?: string;
15805
15928
  /**
15806
15929
  * @remarks
15807
- * Response message.
15930
+ * The returned message.
15808
15931
  *
15809
15932
  * @example
15810
15933
  * success
@@ -15812,7 +15935,7 @@ export class UpdateHttpApiRouteResponseBody extends $dara.Model {
15812
15935
  message?: string;
15813
15936
  /**
15814
15937
  * @remarks
15815
- * Request ID.
15938
+ * The request ID.
15816
15939
  *
15817
15940
  * @example
15818
15941
  * CBEEB8C1-108E-50F0-9BEA-DED79553C309
@@ -16276,7 +16399,7 @@ export default class Client extends OpenApi {
16276
16399
  }
16277
16400
 
16278
16401
  /**
16279
- * Create Domain
16402
+ * Creates a domain name.
16280
16403
  *
16281
16404
  * @remarks
16282
16405
  * Create Domain.
@@ -16361,7 +16484,7 @@ export default class Client extends OpenApi {
16361
16484
  }
16362
16485
 
16363
16486
  /**
16364
- * Create Domain
16487
+ * Creates a domain name.
16365
16488
  *
16366
16489
  * @remarks
16367
16490
  * Create Domain.
@@ -16454,7 +16577,7 @@ export default class Client extends OpenApi {
16454
16577
  }
16455
16578
 
16456
16579
  /**
16457
- * Create an API of HTTP type
16580
+ * Creates an HTTP API.
16458
16581
  *
16459
16582
  * @param request - CreateHttpApiRequest
16460
16583
  * @param headers - map
@@ -16536,7 +16659,7 @@ export default class Client extends OpenApi {
16536
16659
  }
16537
16660
 
16538
16661
  /**
16539
- * Create an API of HTTP type
16662
+ * Creates an HTTP API.
16540
16663
  *
16541
16664
  * @param request - CreateHttpApiRequest
16542
16665
  * @returns CreateHttpApiResponse
@@ -16796,10 +16919,10 @@ export default class Client extends OpenApi {
16796
16919
  }
16797
16920
 
16798
16921
  /**
16799
- * Create Service
16922
+ * Creates a service.
16800
16923
  *
16801
16924
  * @remarks
16802
- * The interface supports creating multiple services.
16925
+ * You can call this operation to create multiple services at a time.
16803
16926
  *
16804
16927
  * @param request - CreateServiceRequest
16805
16928
  * @param headers - map
@@ -16849,10 +16972,10 @@ export default class Client extends OpenApi {
16849
16972
  }
16850
16973
 
16851
16974
  /**
16852
- * Create Service
16975
+ * Creates a service.
16853
16976
  *
16854
16977
  * @remarks
16855
- * The interface supports creating multiple services.
16978
+ * You can call this operation to create multiple services at a time.
16856
16979
  *
16857
16980
  * @param request - CreateServiceRequest
16858
16981
  * @returns CreateServiceResponse
@@ -17334,7 +17457,7 @@ export default class Client extends OpenApi {
17334
17457
  }
17335
17458
 
17336
17459
  /**
17337
- * Get Monitoring/Logging Dashboard Interface
17460
+ * Obtains data from dashboards.
17338
17461
  *
17339
17462
  * @param tmpReq - GetDashboardRequest
17340
17463
  * @param headers - map
@@ -17370,10 +17493,18 @@ export default class Client extends OpenApi {
17370
17493
  query["pluginClassId"] = request.pluginClassId;
17371
17494
  }
17372
17495
 
17496
+ if (!$dara.isNull(request.pluginId)) {
17497
+ query["pluginId"] = request.pluginId;
17498
+ }
17499
+
17373
17500
  if (!$dara.isNull(request.source)) {
17374
17501
  query["source"] = request.source;
17375
17502
  }
17376
17503
 
17504
+ if (!$dara.isNull(request.upstreamCluster)) {
17505
+ query["upstreamCluster"] = request.upstreamCluster;
17506
+ }
17507
+
17377
17508
  let req = new $OpenApiUtil.OpenApiRequest({
17378
17509
  headers: headers,
17379
17510
  query: OpenApiUtil.query(query),
@@ -17398,7 +17529,7 @@ export default class Client extends OpenApi {
17398
17529
  }
17399
17530
 
17400
17531
  /**
17401
- * Get Monitoring/Logging Dashboard Interface
17532
+ * Obtains data from dashboards.
17402
17533
  *
17403
17534
  * @param request - GetDashboardRequest
17404
17535
  * @returns GetDashboardResponse
@@ -17410,7 +17541,7 @@ export default class Client extends OpenApi {
17410
17541
  }
17411
17542
 
17412
17543
  /**
17413
- * Query domain details
17544
+ * Queries the information about a domain name.
17414
17545
  *
17415
17546
  * @param request - GetDomainRequest
17416
17547
  * @param headers - map
@@ -17448,7 +17579,7 @@ export default class Client extends OpenApi {
17448
17579
  }
17449
17580
 
17450
17581
  /**
17451
- * Query domain details
17582
+ * Queries the information about a domain name.
17452
17583
  *
17453
17584
  * @param request - GetDomainRequest
17454
17585
  * @returns GetDomainResponse
@@ -17640,7 +17771,7 @@ export default class Client extends OpenApi {
17640
17771
  }
17641
17772
 
17642
17773
  /**
17643
- * Get the details of an HttpApi route
17774
+ * Queries the details of a route of an HTTP API.
17644
17775
  *
17645
17776
  * @param headers - map
17646
17777
  * @param runtime - runtime options for this request RuntimeOptions
@@ -17670,7 +17801,7 @@ export default class Client extends OpenApi {
17670
17801
  }
17671
17802
 
17672
17803
  /**
17673
- * Get the details of an HttpApi route
17804
+ * Queries the details of a route of an HTTP API.
17674
17805
  * @returns GetHttpApiRouteResponse
17675
17806
  */
17676
17807
  async getHttpApiRoute(httpApiId: string, routeId: string): Promise<GetHttpApiRouteResponse> {
@@ -17680,7 +17811,7 @@ export default class Client extends OpenApi {
17680
17811
  }
17681
17812
 
17682
17813
  /**
17683
- * GetPolicy
17814
+ * Queries a policy.
17684
17815
  *
17685
17816
  * @param headers - map
17686
17817
  * @param runtime - runtime options for this request RuntimeOptions
@@ -17710,7 +17841,7 @@ export default class Client extends OpenApi {
17710
17841
  }
17711
17842
 
17712
17843
  /**
17713
- * GetPolicy
17844
+ * Queries a policy.
17714
17845
  * @returns GetPolicyResponse
17715
17846
  */
17716
17847
  async getPolicy(policyId: string): Promise<GetPolicyResponse> {
@@ -17800,7 +17931,7 @@ export default class Client extends OpenApi {
17800
17931
  }
17801
17932
 
17802
17933
  /**
17803
- * Get Service Details
17934
+ * Queries the details of a service.
17804
17935
  *
17805
17936
  * @param headers - map
17806
17937
  * @param runtime - runtime options for this request RuntimeOptions
@@ -17830,7 +17961,7 @@ export default class Client extends OpenApi {
17830
17961
  }
17831
17962
 
17832
17963
  /**
17833
- * Get Service Details
17964
+ * Queries the details of a service.
17834
17965
  * @returns GetServiceResponse
17835
17966
  */
17836
17967
  async getService(serviceId: string): Promise<GetServiceResponse> {
@@ -17890,7 +18021,7 @@ export default class Client extends OpenApi {
17890
18021
  }
17891
18022
 
17892
18023
  /**
17893
- * Import HttpApi
18024
+ * Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs.
17894
18025
  *
17895
18026
  * @param request - ImportHttpApiRequest
17896
18027
  * @param headers - map
@@ -17964,7 +18095,7 @@ export default class Client extends OpenApi {
17964
18095
  }
17965
18096
 
17966
18097
  /**
17967
- * Import HttpApi
18098
+ * Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs.
17968
18099
  *
17969
18100
  * @param request - ImportHttpApiRequest
17970
18101
  * @returns ImportHttpApiResponse
@@ -17976,7 +18107,7 @@ export default class Client extends OpenApi {
17976
18107
  }
17977
18108
 
17978
18109
  /**
17979
- * ListDomains
18110
+ * Queries a list of domain names.
17980
18111
  *
17981
18112
  * @param request - ListDomainsRequest
17982
18113
  * @param headers - map
@@ -18030,7 +18161,7 @@ export default class Client extends OpenApi {
18030
18161
  }
18031
18162
 
18032
18163
  /**
18033
- * ListDomains
18164
+ * Queries a list of domain names.
18034
18165
  *
18035
18166
  * @param request - ListDomainsRequest
18036
18167
  * @returns ListDomainsResponse
@@ -18122,7 +18253,7 @@ export default class Client extends OpenApi {
18122
18253
  }
18123
18254
 
18124
18255
  /**
18125
- * Retrieve the list of created cloud-native gateways
18256
+ * Queries a list of instances.
18126
18257
  *
18127
18258
  * @param tmpReq - ListGatewaysRequest
18128
18259
  * @param headers - map
@@ -18190,7 +18321,7 @@ export default class Client extends OpenApi {
18190
18321
  }
18191
18322
 
18192
18323
  /**
18193
- * Retrieve the list of created cloud-native gateways
18324
+ * Queries a list of instances.
18194
18325
  *
18195
18326
  * @param request - ListGatewaysRequest
18196
18327
  * @returns ListGatewaysResponse
@@ -18288,7 +18419,7 @@ export default class Client extends OpenApi {
18288
18419
  }
18289
18420
 
18290
18421
  /**
18291
- * Create a route for HttpApi
18422
+ * Queries the routes of an HTTP API.
18292
18423
  *
18293
18424
  * @param request - ListHttpApiRoutesRequest
18294
18425
  * @param headers - map
@@ -18374,7 +18505,7 @@ export default class Client extends OpenApi {
18374
18505
  }
18375
18506
 
18376
18507
  /**
18377
- * Create a route for HttpApi
18508
+ * Queries the routes of an HTTP API.
18378
18509
  *
18379
18510
  * @param request - ListHttpApiRoutesRequest
18380
18511
  * @returns ListHttpApiRoutesResponse
@@ -18386,7 +18517,7 @@ export default class Client extends OpenApi {
18386
18517
  }
18387
18518
 
18388
18519
  /**
18389
- * List HTTP APIs
18520
+ * Queries a list of HTTP APIs.
18390
18521
  *
18391
18522
  * @param request - ListHttpApisRequest
18392
18523
  * @param headers - map
@@ -18424,6 +18555,10 @@ export default class Client extends OpenApi {
18424
18555
  query["types"] = request.types;
18425
18556
  }
18426
18557
 
18558
+ if (!$dara.isNull(request.withAPIsPublishedToEnvironment)) {
18559
+ query["withAPIsPublishedToEnvironment"] = request.withAPIsPublishedToEnvironment;
18560
+ }
18561
+
18427
18562
  if (!$dara.isNull(request.withAuthPolicyInEnvironmentId)) {
18428
18563
  query["withAuthPolicyInEnvironmentId"] = request.withAuthPolicyInEnvironmentId;
18429
18564
  }
@@ -18452,6 +18587,10 @@ export default class Client extends OpenApi {
18452
18587
  query["withPluginAttachmentByPluginId"] = request.withPluginAttachmentByPluginId;
18453
18588
  }
18454
18589
 
18590
+ if (!$dara.isNull(request.withPolicyConfigs)) {
18591
+ query["withPolicyConfigs"] = request.withPolicyConfigs;
18592
+ }
18593
+
18455
18594
  let req = new $OpenApiUtil.OpenApiRequest({
18456
18595
  headers: headers,
18457
18596
  query: OpenApiUtil.query(query),
@@ -18476,7 +18615,7 @@ export default class Client extends OpenApi {
18476
18615
  }
18477
18616
 
18478
18617
  /**
18479
- * List HTTP APIs
18618
+ * Queries a list of HTTP APIs.
18480
18619
  *
18481
18620
  * @param request - ListHttpApisRequest
18482
18621
  * @returns ListHttpApisResponse
@@ -18554,7 +18693,7 @@ export default class Client extends OpenApi {
18554
18693
  }
18555
18694
 
18556
18695
  /**
18557
- * Get Service List
18696
+ * Queries a list of services.
18558
18697
  *
18559
18698
  * @param request - ListServicesRequest
18560
18699
  * @param headers - map
@@ -18588,6 +18727,10 @@ export default class Client extends OpenApi {
18588
18727
  query["sourceType"] = request.sourceType;
18589
18728
  }
18590
18729
 
18730
+ if (!$dara.isNull(request.sourceTypes)) {
18731
+ query["sourceTypes"] = request.sourceTypes;
18732
+ }
18733
+
18591
18734
  let req = new $OpenApiUtil.OpenApiRequest({
18592
18735
  headers: headers,
18593
18736
  query: OpenApiUtil.query(query),
@@ -18612,7 +18755,7 @@ export default class Client extends OpenApi {
18612
18755
  }
18613
18756
 
18614
18757
  /**
18615
- * Get Service List
18758
+ * Queries a list of services.
18616
18759
  *
18617
18760
  * @param request - ListServicesRequest
18618
18761
  * @returns ListServicesResponse
@@ -18820,10 +18963,7 @@ export default class Client extends OpenApi {
18820
18963
  }
18821
18964
 
18822
18965
  /**
18823
- * UpdateDomain
18824
- *
18825
- * @remarks
18826
- * 只有类型为**容器服务**的来源允许更新监听Ingress的配置。
18966
+ * Updates a domain name.
18827
18967
  *
18828
18968
  * @param request - UpdateDomainRequest
18829
18969
  * @param headers - map
@@ -18897,10 +19037,7 @@ export default class Client extends OpenApi {
18897
19037
  }
18898
19038
 
18899
19039
  /**
18900
- * UpdateDomain
18901
- *
18902
- * @remarks
18903
- * 只有类型为**容器服务**的来源允许更新监听Ingress的配置。
19040
+ * Updates a domain name.
18904
19041
  *
18905
19042
  * @param request - UpdateDomainRequest
18906
19043
  * @returns UpdateDomainResponse
@@ -19204,7 +19341,7 @@ export default class Client extends OpenApi {
19204
19341
  }
19205
19342
 
19206
19343
  /**
19207
- * Update the route of HttpApi
19344
+ * Updates the route of an HTTP API.
19208
19345
  *
19209
19346
  * @param request - UpdateHttpApiRouteRequest
19210
19347
  * @param headers - map
@@ -19258,7 +19395,7 @@ export default class Client extends OpenApi {
19258
19395
  }
19259
19396
 
19260
19397
  /**
19261
- * Update the route of HttpApi
19398
+ * Updates the route of an HTTP API.
19262
19399
  *
19263
19400
  * @param request - UpdateHttpApiRouteRequest
19264
19401
  * @returns UpdateHttpApiRouteResponse