@alicloud/apig20240327 3.2.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.js CHANGED
@@ -6265,7 +6265,9 @@ class GetDashboardRequest extends $dara.Model {
6265
6265
  filter: 'filter',
6266
6266
  name: 'name',
6267
6267
  pluginClassId: 'pluginClassId',
6268
+ pluginId: 'pluginId',
6268
6269
  source: 'source',
6270
+ upstreamCluster: 'upstreamCluster',
6269
6271
  };
6270
6272
  }
6271
6273
  static types() {
@@ -6275,7 +6277,9 @@ class GetDashboardRequest extends $dara.Model {
6275
6277
  filter: GetDashboardRequestFilter,
6276
6278
  name: 'string',
6277
6279
  pluginClassId: 'string',
6280
+ pluginId: 'string',
6278
6281
  source: 'string',
6282
+ upstreamCluster: 'string',
6279
6283
  };
6280
6284
  }
6281
6285
  validate() {
@@ -6297,7 +6301,9 @@ class GetDashboardShrinkRequest extends $dara.Model {
6297
6301
  filterShrink: 'filter',
6298
6302
  name: 'name',
6299
6303
  pluginClassId: 'pluginClassId',
6304
+ pluginId: 'pluginId',
6300
6305
  source: 'source',
6306
+ upstreamCluster: 'upstreamCluster',
6301
6307
  };
6302
6308
  }
6303
6309
  static types() {
@@ -6307,7 +6313,9 @@ class GetDashboardShrinkRequest extends $dara.Model {
6307
6313
  filterShrink: 'string',
6308
6314
  name: 'string',
6309
6315
  pluginClassId: 'string',
6316
+ pluginId: 'string',
6310
6317
  source: 'string',
6318
+ upstreamCluster: 'string',
6311
6319
  };
6312
6320
  }
6313
6321
  validate() {
@@ -7665,6 +7673,7 @@ class ListHttpApisRequest extends $dara.Model {
7665
7673
  pageSize: 'pageSize',
7666
7674
  resourceGroupId: 'resourceGroupId',
7667
7675
  types: 'types',
7676
+ withAPIsPublishedToEnvironment: 'withAPIsPublishedToEnvironment',
7668
7677
  withAuthPolicyInEnvironmentId: 'withAuthPolicyInEnvironmentId',
7669
7678
  withAuthPolicyList: 'withAuthPolicyList',
7670
7679
  withConsumerInfoById: 'withConsumerInfoById',
@@ -7672,6 +7681,7 @@ class ListHttpApisRequest extends $dara.Model {
7672
7681
  withEnvironmentInfoById: 'withEnvironmentInfoById',
7673
7682
  withIngressInfo: 'withIngressInfo',
7674
7683
  withPluginAttachmentByPluginId: 'withPluginAttachmentByPluginId',
7684
+ withPolicyConfigs: 'withPolicyConfigs',
7675
7685
  };
7676
7686
  }
7677
7687
  static types() {
@@ -7683,6 +7693,7 @@ class ListHttpApisRequest extends $dara.Model {
7683
7693
  pageSize: 'number',
7684
7694
  resourceGroupId: 'string',
7685
7695
  types: 'string',
7696
+ withAPIsPublishedToEnvironment: 'boolean',
7686
7697
  withAuthPolicyInEnvironmentId: 'string',
7687
7698
  withAuthPolicyList: 'boolean',
7688
7699
  withConsumerInfoById: 'string',
@@ -7690,6 +7701,7 @@ class ListHttpApisRequest extends $dara.Model {
7690
7701
  withEnvironmentInfoById: 'string',
7691
7702
  withIngressInfo: 'boolean',
7692
7703
  withPluginAttachmentByPluginId: 'string',
7704
+ withPolicyConfigs: 'boolean',
7693
7705
  };
7694
7706
  }
7695
7707
  validate() {
@@ -9042,7 +9054,7 @@ class Client extends openapi_core_1.default {
9042
9054
  return await this.changeResourceGroupWithOptions(request, headers, runtime);
9043
9055
  }
9044
9056
  /**
9045
- * Create Domain
9057
+ * Creates a domain name.
9046
9058
  *
9047
9059
  * @remarks
9048
9060
  * Create Domain.
@@ -9114,7 +9126,7 @@ class Client extends openapi_core_1.default {
9114
9126
  }
9115
9127
  }
9116
9128
  /**
9117
- * Create Domain
9129
+ * Creates a domain name.
9118
9130
  *
9119
9131
  * @remarks
9120
9132
  * Create Domain.
@@ -9199,7 +9211,7 @@ class Client extends openapi_core_1.default {
9199
9211
  return await this.createEnvironmentWithOptions(request, headers, runtime);
9200
9212
  }
9201
9213
  /**
9202
- * Create an API of HTTP type
9214
+ * Creates an HTTP API.
9203
9215
  *
9204
9216
  * @param request - CreateHttpApiRequest
9205
9217
  * @param headers - map
@@ -9268,7 +9280,7 @@ class Client extends openapi_core_1.default {
9268
9280
  }
9269
9281
  }
9270
9282
  /**
9271
- * Create an API of HTTP type
9283
+ * Creates an HTTP API.
9272
9284
  *
9273
9285
  * @param request - CreateHttpApiRequest
9274
9286
  * @returns CreateHttpApiResponse
@@ -9503,10 +9515,10 @@ class Client extends openapi_core_1.default {
9503
9515
  return await this.createPolicyAttachmentWithOptions(request, headers, runtime);
9504
9516
  }
9505
9517
  /**
9506
- * Create Service
9518
+ * Creates a service.
9507
9519
  *
9508
9520
  * @remarks
9509
- * The interface supports creating multiple services.
9521
+ * You can call this operation to create multiple services at a time.
9510
9522
  *
9511
9523
  * @param request - CreateServiceRequest
9512
9524
  * @param headers - map
@@ -9551,10 +9563,10 @@ class Client extends openapi_core_1.default {
9551
9563
  }
9552
9564
  }
9553
9565
  /**
9554
- * Create Service
9566
+ * Creates a service.
9555
9567
  *
9556
9568
  * @remarks
9557
- * The interface supports creating multiple services.
9569
+ * You can call this operation to create multiple services at a time.
9558
9570
  *
9559
9571
  * @param request - CreateServiceRequest
9560
9572
  * @returns CreateServiceResponse
@@ -10010,7 +10022,7 @@ class Client extends openapi_core_1.default {
10010
10022
  return await this.exportHttpApiWithOptions(httpApiId, headers, runtime);
10011
10023
  }
10012
10024
  /**
10013
- * Get Monitoring/Logging Dashboard Interface
10025
+ * Obtains data from dashboards.
10014
10026
  *
10015
10027
  * @param tmpReq - GetDashboardRequest
10016
10028
  * @param headers - map
@@ -10040,9 +10052,15 @@ class Client extends openapi_core_1.default {
10040
10052
  if (!$dara.isNull(request.pluginClassId)) {
10041
10053
  query["pluginClassId"] = request.pluginClassId;
10042
10054
  }
10055
+ if (!$dara.isNull(request.pluginId)) {
10056
+ query["pluginId"] = request.pluginId;
10057
+ }
10043
10058
  if (!$dara.isNull(request.source)) {
10044
10059
  query["source"] = request.source;
10045
10060
  }
10061
+ if (!$dara.isNull(request.upstreamCluster)) {
10062
+ query["upstreamCluster"] = request.upstreamCluster;
10063
+ }
10046
10064
  let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
10047
10065
  headers: headers,
10048
10066
  query: openapi_core_2.OpenApiUtil.query(query),
@@ -10066,7 +10084,7 @@ class Client extends openapi_core_1.default {
10066
10084
  }
10067
10085
  }
10068
10086
  /**
10069
- * Get Monitoring/Logging Dashboard Interface
10087
+ * Obtains data from dashboards.
10070
10088
  *
10071
10089
  * @param request - GetDashboardRequest
10072
10090
  * @returns GetDashboardResponse
@@ -10077,7 +10095,7 @@ class Client extends openapi_core_1.default {
10077
10095
  return await this.getDashboardWithOptions(gatewayId, request, headers, runtime);
10078
10096
  }
10079
10097
  /**
10080
- * Query domain details
10098
+ * Queries the information about a domain name.
10081
10099
  *
10082
10100
  * @param request - GetDomainRequest
10083
10101
  * @param headers - map
@@ -10113,7 +10131,7 @@ class Client extends openapi_core_1.default {
10113
10131
  }
10114
10132
  }
10115
10133
  /**
10116
- * Query domain details
10134
+ * Queries the information about a domain name.
10117
10135
  *
10118
10136
  * @param request - GetDomainRequest
10119
10137
  * @returns GetDomainResponse
@@ -10294,7 +10312,7 @@ class Client extends openapi_core_1.default {
10294
10312
  return await this.getHttpApiOperationWithOptions(httpApiId, operationId, headers, runtime);
10295
10313
  }
10296
10314
  /**
10297
- * Get the details of an HttpApi route
10315
+ * Queries the details of a route of an HTTP API.
10298
10316
  *
10299
10317
  * @param headers - map
10300
10318
  * @param runtime - runtime options for this request RuntimeOptions
@@ -10323,7 +10341,7 @@ class Client extends openapi_core_1.default {
10323
10341
  }
10324
10342
  }
10325
10343
  /**
10326
- * Get the details of an HttpApi route
10344
+ * Queries the details of a route of an HTTP API.
10327
10345
  * @returns GetHttpApiRouteResponse
10328
10346
  */
10329
10347
  async getHttpApiRoute(httpApiId, routeId) {
@@ -10332,7 +10350,7 @@ class Client extends openapi_core_1.default {
10332
10350
  return await this.getHttpApiRouteWithOptions(httpApiId, routeId, headers, runtime);
10333
10351
  }
10334
10352
  /**
10335
- * GetPolicy
10353
+ * Queries a policy.
10336
10354
  *
10337
10355
  * @param headers - map
10338
10356
  * @param runtime - runtime options for this request RuntimeOptions
@@ -10361,7 +10379,7 @@ class Client extends openapi_core_1.default {
10361
10379
  }
10362
10380
  }
10363
10381
  /**
10364
- * GetPolicy
10382
+ * Queries a policy.
10365
10383
  * @returns GetPolicyResponse
10366
10384
  */
10367
10385
  async getPolicy(policyId) {
@@ -10446,7 +10464,7 @@ class Client extends openapi_core_1.default {
10446
10464
  return await this.getResourceOverviewWithOptions(headers, runtime);
10447
10465
  }
10448
10466
  /**
10449
- * Get Service Details
10467
+ * Queries the details of a service.
10450
10468
  *
10451
10469
  * @param headers - map
10452
10470
  * @param runtime - runtime options for this request RuntimeOptions
@@ -10475,7 +10493,7 @@ class Client extends openapi_core_1.default {
10475
10493
  }
10476
10494
  }
10477
10495
  /**
10478
- * Get Service Details
10496
+ * Queries the details of a service.
10479
10497
  * @returns GetServiceResponse
10480
10498
  */
10481
10499
  async getService(serviceId) {
@@ -10531,7 +10549,7 @@ class Client extends openapi_core_1.default {
10531
10549
  return await this.getTraceConfigWithOptions(gatewayId, request, headers, runtime);
10532
10550
  }
10533
10551
  /**
10534
- * Import HttpApi
10552
+ * Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs.
10535
10553
  *
10536
10554
  * @param request - ImportHttpApiRequest
10537
10555
  * @param headers - map
@@ -10594,7 +10612,7 @@ class Client extends openapi_core_1.default {
10594
10612
  }
10595
10613
  }
10596
10614
  /**
10597
- * Import HttpApi
10615
+ * Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs.
10598
10616
  *
10599
10617
  * @param request - ImportHttpApiRequest
10600
10618
  * @returns ImportHttpApiResponse
@@ -10605,7 +10623,7 @@ class Client extends openapi_core_1.default {
10605
10623
  return await this.importHttpApiWithOptions(request, headers, runtime);
10606
10624
  }
10607
10625
  /**
10608
- * ListDomains
10626
+ * Queries a list of domain names.
10609
10627
  *
10610
10628
  * @param request - ListDomainsRequest
10611
10629
  * @param headers - map
@@ -10653,7 +10671,7 @@ class Client extends openapi_core_1.default {
10653
10671
  }
10654
10672
  }
10655
10673
  /**
10656
- * ListDomains
10674
+ * Queries a list of domain names.
10657
10675
  *
10658
10676
  * @param request - ListDomainsRequest
10659
10677
  * @returns ListDomainsResponse
@@ -10735,7 +10753,7 @@ class Client extends openapi_core_1.default {
10735
10753
  return await this.listEnvironmentsWithOptions(request, headers, runtime);
10736
10754
  }
10737
10755
  /**
10738
- * Retrieve the list of created cloud-native gateways
10756
+ * Queries a list of instances.
10739
10757
  *
10740
10758
  * @param tmpReq - ListGatewaysRequest
10741
10759
  * @param headers - map
@@ -10794,7 +10812,7 @@ class Client extends openapi_core_1.default {
10794
10812
  }
10795
10813
  }
10796
10814
  /**
10797
- * Retrieve the list of created cloud-native gateways
10815
+ * Queries a list of instances.
10798
10816
  *
10799
10817
  * @param request - ListGatewaysRequest
10800
10818
  * @returns ListGatewaysResponse
@@ -10879,7 +10897,7 @@ class Client extends openapi_core_1.default {
10879
10897
  return await this.listHttpApiOperationsWithOptions(httpApiId, request, headers, runtime);
10880
10898
  }
10881
10899
  /**
10882
- * Create a route for HttpApi
10900
+ * Queries the routes of an HTTP API.
10883
10901
  *
10884
10902
  * @param request - ListHttpApiRoutesRequest
10885
10903
  * @param headers - map
@@ -10951,7 +10969,7 @@ class Client extends openapi_core_1.default {
10951
10969
  }
10952
10970
  }
10953
10971
  /**
10954
- * Create a route for HttpApi
10972
+ * Queries the routes of an HTTP API.
10955
10973
  *
10956
10974
  * @param request - ListHttpApiRoutesRequest
10957
10975
  * @returns ListHttpApiRoutesResponse
@@ -10962,7 +10980,7 @@ class Client extends openapi_core_1.default {
10962
10980
  return await this.listHttpApiRoutesWithOptions(httpApiId, request, headers, runtime);
10963
10981
  }
10964
10982
  /**
10965
- * List HTTP APIs
10983
+ * Queries a list of HTTP APIs.
10966
10984
  *
10967
10985
  * @param request - ListHttpApisRequest
10968
10986
  * @param headers - map
@@ -10993,6 +11011,9 @@ class Client extends openapi_core_1.default {
10993
11011
  if (!$dara.isNull(request.types)) {
10994
11012
  query["types"] = request.types;
10995
11013
  }
11014
+ if (!$dara.isNull(request.withAPIsPublishedToEnvironment)) {
11015
+ query["withAPIsPublishedToEnvironment"] = request.withAPIsPublishedToEnvironment;
11016
+ }
10996
11017
  if (!$dara.isNull(request.withAuthPolicyInEnvironmentId)) {
10997
11018
  query["withAuthPolicyInEnvironmentId"] = request.withAuthPolicyInEnvironmentId;
10998
11019
  }
@@ -11014,6 +11035,9 @@ class Client extends openapi_core_1.default {
11014
11035
  if (!$dara.isNull(request.withPluginAttachmentByPluginId)) {
11015
11036
  query["withPluginAttachmentByPluginId"] = request.withPluginAttachmentByPluginId;
11016
11037
  }
11038
+ if (!$dara.isNull(request.withPolicyConfigs)) {
11039
+ query["withPolicyConfigs"] = request.withPolicyConfigs;
11040
+ }
11017
11041
  let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
11018
11042
  headers: headers,
11019
11043
  query: openapi_core_2.OpenApiUtil.query(query),
@@ -11037,7 +11061,7 @@ class Client extends openapi_core_1.default {
11037
11061
  }
11038
11062
  }
11039
11063
  /**
11040
- * List HTTP APIs
11064
+ * Queries a list of HTTP APIs.
11041
11065
  *
11042
11066
  * @param request - ListHttpApisRequest
11043
11067
  * @returns ListHttpApisResponse
@@ -11107,7 +11131,7 @@ class Client extends openapi_core_1.default {
11107
11131
  return await this.listPolicyClassesWithOptions(request, headers, runtime);
11108
11132
  }
11109
11133
  /**
11110
- * Get Service List
11134
+ * Queries a list of services.
11111
11135
  *
11112
11136
  * @param request - ListServicesRequest
11113
11137
  * @param headers - map
@@ -11158,7 +11182,7 @@ class Client extends openapi_core_1.default {
11158
11182
  }
11159
11183
  }
11160
11184
  /**
11161
- * Get Service List
11185
+ * Queries a list of services.
11162
11186
  *
11163
11187
  * @param request - ListServicesRequest
11164
11188
  * @returns ListServicesResponse
@@ -11351,10 +11375,7 @@ class Client extends openapi_core_1.default {
11351
11375
  return await this.undeployHttpApiWithOptions(httpApiId, request, headers, runtime);
11352
11376
  }
11353
11377
  /**
11354
- * UpdateDomain
11355
- *
11356
- * @remarks
11357
- * 只有类型为**容器服务**的来源允许更新监听Ingress的配置。
11378
+ * Updates a domain name.
11358
11379
  *
11359
11380
  * @param request - UpdateDomainRequest
11360
11381
  * @param headers - map
@@ -11417,10 +11438,7 @@ class Client extends openapi_core_1.default {
11417
11438
  }
11418
11439
  }
11419
11440
  /**
11420
- * UpdateDomain
11421
- *
11422
- * @remarks
11423
- * 只有类型为**容器服务**的来源允许更新监听Ingress的配置。
11441
+ * Updates a domain name.
11424
11442
  *
11425
11443
  * @param request - UpdateDomainRequest
11426
11444
  * @returns UpdateDomainResponse
@@ -11699,7 +11717,7 @@ class Client extends openapi_core_1.default {
11699
11717
  return await this.updateHttpApiOperationWithOptions(httpApiId, operationId, request, headers, runtime);
11700
11718
  }
11701
11719
  /**
11702
- * Update the route of HttpApi
11720
+ * Updates the route of an HTTP API.
11703
11721
  *
11704
11722
  * @param request - UpdateHttpApiRouteRequest
11705
11723
  * @param headers - map
@@ -11747,7 +11765,7 @@ class Client extends openapi_core_1.default {
11747
11765
  }
11748
11766
  }
11749
11767
  /**
11750
- * Update the route of HttpApi
11768
+ * Updates the route of an HTTP API.
11751
11769
  *
11752
11770
  * @param request - UpdateHttpApiRouteRequest
11753
11771
  * @returns UpdateHttpApiRouteResponse