@alicloud/apig20240327 3.1.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.
Files changed (5) hide show
  1. package/dist/client.d.ts +1454 -384
  2. package/dist/client.js +252 -66
  3. package/dist/client.js.map +1 -1
  4. package/package.json +1 -1
  5. package/src/client.ts +1594 -379
package/dist/client.d.ts CHANGED
@@ -1064,7 +1064,7 @@ export declare class TlsCipherSuitesConfigTlsCipherSuite extends $dara.Model {
1064
1064
  export declare class CreateDomainResponseBodyData extends $dara.Model {
1065
1065
  /**
1066
1066
  * @remarks
1067
- * Domain ID.
1067
+ * The ID of the domain name.
1068
1068
  *
1069
1069
  * @example
1070
1070
  * d-cpu1aullhtgkidg7sa4g
@@ -1104,7 +1104,7 @@ export declare class CreateEnvironmentResponseBodyData extends $dara.Model {
1104
1104
  export declare class CreateHttpApiRequestIngressConfig extends $dara.Model {
1105
1105
  /**
1106
1106
  * @remarks
1107
- * Environment ID.
1107
+ * The environment ID.
1108
1108
  *
1109
1109
  * @example
1110
1110
  * env-cq146allhtgk***
@@ -1112,7 +1112,7 @@ export declare class CreateHttpApiRequestIngressConfig extends $dara.Model {
1112
1112
  environmentId?: string;
1113
1113
  /**
1114
1114
  * @remarks
1115
- * Ingress Class being listened to.
1115
+ * The Ingress Class for listening.
1116
1116
  *
1117
1117
  * @example
1118
1118
  * mse
@@ -1120,7 +1120,7 @@ export declare class CreateHttpApiRequestIngressConfig extends $dara.Model {
1120
1120
  ingressClass?: string;
1121
1121
  /**
1122
1122
  * @remarks
1123
- * Whether to update the address in the Ingress Status.
1123
+ * Specifies whether to update the address in Ingress Status.
1124
1124
  *
1125
1125
  * @example
1126
1126
  * false
@@ -1128,7 +1128,7 @@ export declare class CreateHttpApiRequestIngressConfig extends $dara.Model {
1128
1128
  overrideIngressIp?: boolean;
1129
1129
  /**
1130
1130
  * @remarks
1131
- * Source ID.
1131
+ * The source ID.
1132
1132
  *
1133
1133
  * @example
1134
1134
  * src-crdddallhtgtr***
@@ -1136,7 +1136,7 @@ export declare class CreateHttpApiRequestIngressConfig extends $dara.Model {
1136
1136
  sourceId?: string;
1137
1137
  /**
1138
1138
  * @remarks
1139
- * Namespace being watched.
1139
+ * The namespace for listening.
1140
1140
  *
1141
1141
  * @example
1142
1142
  * default
@@ -1156,7 +1156,7 @@ export declare class CreateHttpApiRequestIngressConfig extends $dara.Model {
1156
1156
  export declare class CreateHttpApiResponseBodyData extends $dara.Model {
1157
1157
  /**
1158
1158
  * @remarks
1159
- * HTTP API ID.
1159
+ * The HTTP API ID.
1160
1160
  *
1161
1161
  * @example
1162
1162
  * api-xxx
@@ -1164,7 +1164,7 @@ export declare class CreateHttpApiResponseBodyData extends $dara.Model {
1164
1164
  httpApiId?: string;
1165
1165
  /**
1166
1166
  * @remarks
1167
- * Name of the API.
1167
+ * The API name.
1168
1168
  *
1169
1169
  * @example
1170
1170
  * test-api
@@ -1221,7 +1221,7 @@ export declare class CreateHttpApiOperationResponseBodyData extends $dara.Model
1221
1221
  export declare class CreateHttpApiRouteRequestBackendConfigServices extends $dara.Model {
1222
1222
  /**
1223
1223
  * @remarks
1224
- * Service port, not provided for dynamic ports.
1224
+ * The service port. If you want to use a dynamic port, do not pass this parameter.
1225
1225
  *
1226
1226
  * @example
1227
1227
  * 8080
@@ -1229,9 +1229,10 @@ export declare class CreateHttpApiRouteRequestBackendConfigServices extends $dar
1229
1229
  port?: number;
1230
1230
  /**
1231
1231
  * @remarks
1232
- * Service protocol:
1233
- * - HTTP.
1234
- * - HTTPS.
1232
+ * The protocol. Valid values:
1233
+ *
1234
+ * * HTTP
1235
+ * * HTTPS
1235
1236
  *
1236
1237
  * @example
1237
1238
  * HTTP
@@ -1239,7 +1240,7 @@ export declare class CreateHttpApiRouteRequestBackendConfigServices extends $dar
1239
1240
  protocol?: string;
1240
1241
  /**
1241
1242
  * @remarks
1242
- * Service ID.
1243
+ * The service ID.
1243
1244
  *
1244
1245
  * @example
1245
1246
  * svc-crbgq0dlhtgr***
@@ -1247,7 +1248,7 @@ export declare class CreateHttpApiRouteRequestBackendConfigServices extends $dar
1247
1248
  serviceId?: string;
1248
1249
  /**
1249
1250
  * @remarks
1250
- * Service version, valid only in label-based scenarios.
1251
+ * The service version. Pass this parameter for tag-based routing.
1251
1252
  *
1252
1253
  * @example
1253
1254
  * v1
@@ -1255,7 +1256,7 @@ export declare class CreateHttpApiRouteRequestBackendConfigServices extends $dar
1255
1256
  version?: string;
1256
1257
  /**
1257
1258
  * @remarks
1258
- * Percentage value of traffic distribution.
1259
+ * The percentage value of traffic.
1259
1260
  *
1260
1261
  * @example
1261
1262
  * 49
@@ -1275,11 +1276,12 @@ export declare class CreateHttpApiRouteRequestBackendConfigServices extends $dar
1275
1276
  export declare class CreateHttpApiRouteRequestBackendConfig extends $dara.Model {
1276
1277
  /**
1277
1278
  * @remarks
1278
- * Backend service scenario.
1279
- * - SingleService: Single service.
1280
- * - MultiServiceByRatio: Multiple services with ratio-based canary release.
1281
- * - Mock: Mock service.
1282
- * - Redirect: Redirect service.
1279
+ * The scenario of the backend service.
1280
+ *
1281
+ * * SingleService
1282
+ * * MultiServiceByRatio
1283
+ * * Mock
1284
+ * * Redirect
1283
1285
  *
1284
1286
  * @example
1285
1287
  * SingleService
@@ -1287,7 +1289,7 @@ export declare class CreateHttpApiRouteRequestBackendConfig extends $dara.Model
1287
1289
  scene?: string;
1288
1290
  /**
1289
1291
  * @remarks
1290
- * List of backend services.
1292
+ * The backend services.
1291
1293
  */
1292
1294
  services?: CreateHttpApiRouteRequestBackendConfigServices[];
1293
1295
  static names(): {
@@ -1304,7 +1306,7 @@ export declare class CreateHttpApiRouteRequestBackendConfig extends $dara.Model
1304
1306
  export declare class CreateHttpApiRouteResponseBodyData extends $dara.Model {
1305
1307
  /**
1306
1308
  * @remarks
1307
- * Route ID。
1309
+ * The route ID.
1308
1310
  *
1309
1311
  * @example
1310
1312
  * hr-cr82undlhtgrlej***
@@ -1323,6 +1325,9 @@ export declare class CreateHttpApiRouteResponseBodyData extends $dara.Model {
1323
1325
  }
1324
1326
  export declare class CreatePolicyResponseBodyData extends $dara.Model {
1325
1327
  /**
1328
+ * @remarks
1329
+ * Policy ID
1330
+ *
1326
1331
  * @example
1327
1332
  * p-cq7l5s5lhtgi6qasr***
1328
1333
  */
@@ -1340,6 +1345,9 @@ export declare class CreatePolicyResponseBodyData extends $dara.Model {
1340
1345
  }
1341
1346
  export declare class CreatePolicyAttachmentResponseBodyData extends $dara.Model {
1342
1347
  /**
1348
+ * @remarks
1349
+ * Policy Mount ID
1350
+ *
1343
1351
  * @example
1344
1352
  * pr-cqooju5lhtgquuj6***
1345
1353
  */
@@ -1356,24 +1364,52 @@ export declare class CreatePolicyAttachmentResponseBodyData extends $dara.Model
1356
1364
  });
1357
1365
  }
1358
1366
  export declare class CreateServiceRequestServiceConfigs extends $dara.Model {
1367
+ /**
1368
+ * @remarks
1369
+ * The list of domain names or fixed addresses.
1370
+ */
1359
1371
  addresses?: string[];
1372
+ /**
1373
+ * @remarks
1374
+ * The AI service configurations.
1375
+ */
1360
1376
  aiServiceConfig?: AiServiceConfig;
1361
1377
  /**
1378
+ * @remarks
1379
+ * The list of DNS service addresses.
1380
+ */
1381
+ dnsServers?: string[];
1382
+ /**
1383
+ * @remarks
1384
+ * The service group name. This parameter is required if sourceType is set to MSE_NACOS.
1385
+ *
1362
1386
  * @example
1363
1387
  * DEFAULT_GROUP
1364
1388
  */
1365
1389
  groupName?: string;
1366
1390
  /**
1391
+ * @remarks
1392
+ * The service name.
1393
+ *
1367
1394
  * @example
1368
1395
  * user-service
1369
1396
  */
1370
1397
  name?: string;
1371
1398
  /**
1399
+ * @remarks
1400
+ * The service namespace. This parameter is required when sourceType is set to K8S or MSE_NACOS.
1401
+ *
1402
+ * * If sourceType is set to K8S, this parameter specifies the namespace where the K8s service resides.
1403
+ * * If sourceType is set to MSE_NACOS, this parameter specifies a namespace in Nacos.
1404
+ *
1372
1405
  * @example
1373
1406
  * PUBLIC
1374
1407
  */
1375
1408
  namespace?: string;
1376
1409
  /**
1410
+ * @remarks
1411
+ * The function version or alias.
1412
+ *
1377
1413
  * @example
1378
1414
  * LATEST
1379
1415
  */
@@ -1390,6 +1426,10 @@ export declare class CreateServiceRequestServiceConfigs extends $dara.Model {
1390
1426
  });
1391
1427
  }
1392
1428
  export declare class CreateServiceResponseBodyData extends $dara.Model {
1429
+ /**
1430
+ * @remarks
1431
+ * The list of service IDs.
1432
+ */
1393
1433
  serviceIds?: string[];
1394
1434
  static names(): {
1395
1435
  [key: string]: string;
@@ -1403,28 +1443,49 @@ export declare class CreateServiceResponseBodyData extends $dara.Model {
1403
1443
  });
1404
1444
  }
1405
1445
  export declare class DeployHttpApiRequestRestApiConfigEnvironmentServiceConfigs extends $dara.Model {
1446
+ /**
1447
+ * @remarks
1448
+ * Configuration of matching conditions related to API deployment.
1449
+ */
1406
1450
  match?: HttpApiBackendMatchConditions;
1407
1451
  /**
1452
+ * @remarks
1453
+ * Service port, do not provide for dynamic ports.
1454
+ *
1408
1455
  * @example
1409
1456
  * 8080
1410
1457
  */
1411
1458
  port?: number;
1412
1459
  /**
1460
+ * @remarks
1461
+ * Service protocol:
1462
+ * - HTTP.
1463
+ * - HTTPS.
1464
+ *
1413
1465
  * @example
1414
1466
  * HTTP
1415
1467
  */
1416
1468
  protocol?: string;
1417
1469
  /**
1470
+ * @remarks
1471
+ * Service ID.
1472
+ *
1418
1473
  * @example
1419
1474
  * svc-cr6pk4tlhtgm58e***
1420
1475
  */
1421
1476
  serviceId?: string;
1422
1477
  /**
1478
+ * @remarks
1479
+ * Service version.
1480
+ *
1423
1481
  * @example
1424
1482
  * v1
1425
1483
  */
1426
1484
  version?: string;
1427
1485
  /**
1486
+ * @remarks
1487
+ * Weight, range [1,100], valid only in the by-ratio scenario.
1488
+ *
1428
1489
  * @example
1429
1490
  * 49
1430
1491
  */
@@ -1442,16 +1503,30 @@ export declare class DeployHttpApiRequestRestApiConfigEnvironmentServiceConfigs
1442
1503
  }
1443
1504
  export declare class DeployHttpApiRequestRestApiConfigEnvironment extends $dara.Model {
1444
1505
  /**
1506
+ * @remarks
1507
+ * API publication scenario.
1508
+ *
1445
1509
  * @example
1446
1510
  * SingleService
1447
1511
  */
1448
1512
  backendScene?: string;
1513
+ /**
1514
+ * @remarks
1515
+ * List of user domains.
1516
+ */
1449
1517
  customDomainIds?: string[];
1450
1518
  /**
1519
+ * @remarks
1520
+ * Environment ID.
1521
+ *
1451
1522
  * @example
1452
1523
  * env-cpqnr6tlhtgubc***
1453
1524
  */
1454
1525
  environmentId?: string;
1526
+ /**
1527
+ * @remarks
1528
+ * Existing service configurations. Only one entry is allowed in a single-service scenario, while multiple entries are allowed in scenarios such as by ratio or by content.
1529
+ */
1455
1530
  serviceConfigs?: DeployHttpApiRequestRestApiConfigEnvironmentServiceConfigs[];
1456
1531
  static names(): {
1457
1532
  [key: string]: string;
@@ -1465,9 +1540,23 @@ export declare class DeployHttpApiRequestRestApiConfigEnvironment extends $dara.
1465
1540
  });
1466
1541
  }
1467
1542
  export declare class DeployHttpApiRequestRestApiConfig extends $dara.Model {
1543
+ /**
1544
+ * @remarks
1545
+ * Publication description.
1546
+ *
1547
+ * @example
1548
+ * 用户服务API发布。
1549
+ */
1468
1550
  description?: string;
1551
+ /**
1552
+ * @remarks
1553
+ * Publication environment configuration.
1554
+ */
1469
1555
  environment?: DeployHttpApiRequestRestApiConfigEnvironment;
1470
1556
  /**
1557
+ * @remarks
1558
+ * Historical version number. If this field is specified, the publication information will be based on the historical version information.
1559
+ *
1471
1560
  * @example
1472
1561
  * apr-xxx
1473
1562
  */
@@ -1505,6 +1594,9 @@ export declare class ExportHttpApiResponseBodyData extends $dara.Model {
1505
1594
  }
1506
1595
  export declare class GetDashboardRequestFilter extends $dara.Model {
1507
1596
  /**
1597
+ * @remarks
1598
+ * The route name.
1599
+ *
1508
1600
  * @example
1509
1601
  * test-route
1510
1602
  */
@@ -1522,21 +1614,33 @@ export declare class GetDashboardRequestFilter extends $dara.Model {
1522
1614
  }
1523
1615
  export declare class GetDashboardResponseBodyData extends $dara.Model {
1524
1616
  /**
1617
+ * @remarks
1618
+ * The instance ID.
1619
+ *
1525
1620
  * @example
1526
1621
  * gw-co370icmjeu****
1527
1622
  */
1528
1623
  gatewayId?: string;
1529
1624
  /**
1625
+ * @remarks
1626
+ * The dashboard name.
1627
+ *
1530
1628
  * @example
1531
1629
  * PLUGIN
1532
1630
  */
1533
1631
  name?: string;
1534
1632
  /**
1633
+ * @remarks
1634
+ * The dashboard title.
1635
+ *
1535
1636
  * @example
1536
1637
  * APIG Plugin
1537
1638
  */
1538
1639
  title?: string;
1539
1640
  /**
1641
+ * @remarks
1642
+ * The dashboard URL.
1643
+ *
1540
1644
  * @example
1541
1645
  * https://sls.console.aliyun.com/lognext/project/xxxxx
1542
1646
  */
@@ -1553,7 +1657,18 @@ export declare class GetDashboardResponseBodyData extends $dara.Model {
1553
1657
  });
1554
1658
  }
1555
1659
  export declare class GetDomainResponseBodyDataStatisticsInfo extends $dara.Model {
1660
+ /**
1661
+ * @remarks
1662
+ * The resource statistics.
1663
+ */
1556
1664
  resourceStatistics?: ResourceStatistic[];
1665
+ /**
1666
+ * @remarks
1667
+ * The total number of resources.
1668
+ *
1669
+ * @example
1670
+ * 1
1671
+ */
1557
1672
  totalCount?: string;
1558
1673
  static names(): {
1559
1674
  [key: string]: string;
@@ -1569,17 +1684,31 @@ export declare class GetDomainResponseBodyDataStatisticsInfo extends $dara.Model
1569
1684
  export declare class GetDomainResponseBodyData extends $dara.Model {
1570
1685
  /**
1571
1686
  * @remarks
1572
- * Encryption algorithm name
1687
+ * The encryption algorithm.
1573
1688
  *
1574
1689
  * @example
1575
1690
  * RSA
1576
1691
  */
1577
1692
  algorithm?: string;
1693
+ /**
1694
+ * @remarks
1695
+ * The CA certificate ID.
1696
+ *
1697
+ * @example
1698
+ * 876****-cn-hangzhou
1699
+ */
1578
1700
  caCertIdentifier?: string;
1701
+ /**
1702
+ * @remarks
1703
+ * The certificate ID.
1704
+ *
1705
+ * @example
1706
+ * 645****-cn-hangzhou
1707
+ */
1579
1708
  certIdentifier?: string;
1580
1709
  /**
1581
1710
  * @remarks
1582
- * Certificate name
1711
+ * The certificate name.
1583
1712
  *
1584
1713
  * @example
1585
1714
  * test-cert
@@ -1587,7 +1716,27 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1587
1716
  certName?: string;
1588
1717
  /**
1589
1718
  * @remarks
1590
- * Where it was created from.
1719
+ * The client CA certificate.
1720
+ *
1721
+ * @example
1722
+ * -----BEGIN CERTIFICATE-----
1723
+ * xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/mpTQwDQYJKoZIhvcNAQEL
1724
+ * BxSbrGeJ8i0576Gn7Qezyho9abZOUhGaPeoB
1725
+ * AIHWWl428uUSG/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
1726
+ * yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy+ZMJ8r4swA4swHwYDVR0jBBgwFoAU
1727
+ * qroVyYKk7ylhcSn+ZMJ8r4swA4swDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0B
1728
+ * xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
1729
+ * -----END CERTIFICATE-----
1730
+ */
1731
+ clientCACert?: string;
1732
+ /**
1733
+ * @remarks
1734
+ * The creation source.
1735
+ *
1736
+ * Valid values:
1737
+ *
1738
+ * * Console
1739
+ * * Ingress
1591
1740
  *
1592
1741
  * @example
1593
1742
  * Console
@@ -1595,7 +1744,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1595
1744
  createFrom?: string;
1596
1745
  /**
1597
1746
  * @remarks
1598
- * Creation timestamp.
1747
+ * The creation timestamp.
1599
1748
  *
1600
1749
  * @example
1601
1750
  * 1719386834548
@@ -1603,7 +1752,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1603
1752
  createTimestamp?: number;
1604
1753
  /**
1605
1754
  * @remarks
1606
- * Whether it is the default domain.
1755
+ * Indicates whether the domain name is the default domain name.
1607
1756
  *
1608
1757
  * @example
1609
1758
  * false
@@ -1611,7 +1760,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1611
1760
  default?: boolean;
1612
1761
  /**
1613
1762
  * @remarks
1614
- * Domain ID.
1763
+ * The ID of the domain name.
1615
1764
  *
1616
1765
  * @example
1617
1766
  * d-cq1m3utlhtgvgkv7sitg
@@ -1619,7 +1768,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1619
1768
  domainId?: string;
1620
1769
  /**
1621
1770
  * @remarks
1622
- * Setting for HTTPS protocol type, whether to enable forced HTTPS redirection.
1771
+ * Indicates whether forcible HTTPS redirection is enabled.
1623
1772
  *
1624
1773
  * @example
1625
1774
  * false
@@ -1627,7 +1776,13 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1627
1776
  forceHttps?: boolean;
1628
1777
  /**
1629
1778
  * @remarks
1630
- * HTTP/2 setting.
1779
+ * The HTTP/2 configuration.
1780
+ *
1781
+ * Valid values:
1782
+ *
1783
+ * * GlobalConfig
1784
+ * * Close
1785
+ * * Open
1631
1786
  *
1632
1787
  * @example
1633
1788
  * Open
@@ -1635,7 +1790,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1635
1790
  http2Option?: string;
1636
1791
  /**
1637
1792
  * @remarks
1638
- * Certificate issuer.
1793
+ * The certificate issuer.
1639
1794
  *
1640
1795
  * @example
1641
1796
  * Alibaba
@@ -1643,7 +1798,20 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1643
1798
  issuer?: string;
1644
1799
  /**
1645
1800
  * @remarks
1646
- * Domain name.
1801
+ * Indicates whether mutual authentication is enabled.
1802
+ *
1803
+ * Valid values:
1804
+ *
1805
+ * * false
1806
+ * * true
1807
+ *
1808
+ * @example
1809
+ * false
1810
+ */
1811
+ mTLSEnabled?: boolean;
1812
+ /**
1813
+ * @remarks
1814
+ * The domain name.
1647
1815
  *
1648
1816
  * @example
1649
1817
  * abc.com
@@ -1651,7 +1819,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1651
1819
  name?: string;
1652
1820
  /**
1653
1821
  * @remarks
1654
- * Certificate expiration time.
1822
+ * The expiration time of the certificate.
1655
1823
  *
1656
1824
  * @example
1657
1825
  * 1719386834548
@@ -1659,7 +1827,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1659
1827
  notAfterTimstamp?: number;
1660
1828
  /**
1661
1829
  * @remarks
1662
- * Certificate effective time.
1830
+ * The time when the certificate started to take effect.
1663
1831
  *
1664
1832
  * @example
1665
1833
  * 1719386834548
@@ -1667,29 +1835,44 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1667
1835
  notBeforeTimestamp?: number;
1668
1836
  /**
1669
1837
  * @remarks
1670
- * The protocol types supported by the domain.
1838
+ * The supported protocol. Valid values:
1671
1839
  *
1672
- * - HTTP: Supports only HTTP protocol.
1673
- * - HTTPS: Supports only HTTPS protocol.
1840
+ * * HTTP: Only HTTP is supported.
1841
+ * * HTTPS: Only HTTPS is supported.
1674
1842
  *
1675
1843
  * @example
1676
1844
  * HTTP
1677
1845
  */
1678
1846
  protocol?: string;
1847
+ /**
1848
+ * @remarks
1849
+ * The resource group ID.
1850
+ *
1851
+ * @example
1852
+ * rg-aekzvlxzgo5b4si
1853
+ */
1679
1854
  resourceGroupId?: string;
1680
1855
  /**
1681
1856
  * @remarks
1682
- * All domain names bound to the certificate.
1857
+ * All domain names that are bound to the certificate.
1683
1858
  *
1684
1859
  * @example
1685
1860
  * aliyun.com
1686
1861
  */
1687
1862
  sans?: string;
1863
+ /**
1864
+ * @remarks
1865
+ * The information about online resources.
1866
+ */
1688
1867
  statisticsInfo?: GetDomainResponseBodyDataStatisticsInfo;
1868
+ /**
1869
+ * @remarks
1870
+ * The cipher suite configuration.
1871
+ */
1689
1872
  tlsCipherSuitesConfig?: TlsCipherSuitesConfig;
1690
1873
  /**
1691
1874
  * @remarks
1692
- * Maximum TLS protocol version, supports up to TLS 1.3.
1875
+ * The maximum version of the TLS protocol. Up to TLS 1.3 is supported.
1693
1876
  *
1694
1877
  * @example
1695
1878
  * TLS 1.3
@@ -1697,7 +1880,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1697
1880
  tlsMax?: string;
1698
1881
  /**
1699
1882
  * @remarks
1700
- * Minimum TLS protocol version, supports down to TLS 1.0.
1883
+ * The minimum version of the TLS protocol. Down to TLS 1.0 is supported.
1701
1884
  *
1702
1885
  * @example
1703
1886
  * TLS 1.0
@@ -1705,7 +1888,7 @@ export declare class GetDomainResponseBodyData extends $dara.Model {
1705
1888
  tlsMin?: string;
1706
1889
  /**
1707
1890
  * @remarks
1708
- * Update timestamp.
1891
+ * The update timestamp.
1709
1892
  *
1710
1893
  * @example
1711
1894
  * 1719386834548
@@ -2333,36 +2516,57 @@ export declare class GetGatewayResponseBodyData extends $dara.Model {
2333
2516
  }
2334
2517
  export declare class GetPolicyAttachmentResponseBodyData extends $dara.Model {
2335
2518
  /**
2519
+ * @remarks
2520
+ * Attached Resource ID
2521
+ *
2336
2522
  * @example
2337
2523
  * op-csbkd9llhtgqhqua***
2338
2524
  */
2339
2525
  attachResourceId?: string;
2340
2526
  /**
2527
+ * @remarks
2528
+ * Attached resource type, HttpApi, GatewayRoute, Operation, GatewayService, GatewayServicePort, Gateway, Domain
2529
+ *
2341
2530
  * @example
2342
2531
  * Operation
2343
2532
  */
2344
2533
  attachResourceType?: string;
2345
2534
  /**
2535
+ * @remarks
2536
+ * Policy attachment configuration
2537
+ *
2346
2538
  * @example
2347
2539
  * {"unitNum":1,"timeUnit":"s","enable":true}
2348
2540
  */
2349
2541
  config?: string;
2350
2542
  /**
2543
+ * @remarks
2544
+ * Environment ID
2545
+ *
2351
2546
  * @example
2352
2547
  * env-cq7l5s5lhtgi6qa***
2353
2548
  */
2354
2549
  environmentId?: string;
2355
2550
  /**
2551
+ * @remarks
2552
+ * Gateway Instance ID
2553
+ *
2356
2554
  * @example
2357
2555
  * gw-cq2vundlhtg***
2358
2556
  */
2359
2557
  gatewayId?: string;
2360
2558
  /**
2559
+ * @remarks
2560
+ * Policy Attachment ID
2561
+ *
2361
2562
  * @example
2362
2563
  * pr-cqoojualhtgquuj***
2363
2564
  */
2364
2565
  policyAttachmentId?: string;
2365
2566
  /**
2567
+ * @remarks
2568
+ * Policy ID
2569
+ *
2366
2570
  * @example
2367
2571
  * p-cq7l5s5bblhtgi6qas***
2368
2572
  */
@@ -2380,11 +2584,17 @@ export declare class GetPolicyAttachmentResponseBodyData extends $dara.Model {
2380
2584
  }
2381
2585
  export declare class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
2382
2586
  /**
2587
+ * @remarks
2588
+ * Number of published APIs.
2589
+ *
2383
2590
  * @example
2384
2591
  * 1
2385
2592
  */
2386
2593
  publishedCount?: number;
2387
2594
  /**
2595
+ * @remarks
2596
+ * Number of APIs.
2597
+ *
2388
2598
  * @example
2389
2599
  * 1
2390
2600
  */
@@ -2402,11 +2612,17 @@ export declare class GetResourceOverviewResponseBodyDataApi extends $dara.Model
2402
2612
  }
2403
2613
  export declare class GetResourceOverviewResponseBodyDataGateway extends $dara.Model {
2404
2614
  /**
2615
+ * @remarks
2616
+ * Number of running gateways.
2617
+ *
2405
2618
  * @example
2406
2619
  * 1
2407
2620
  */
2408
2621
  runningCount?: number;
2409
2622
  /**
2623
+ * @remarks
2624
+ * Number of gateway instances.
2625
+ *
2410
2626
  * @example
2411
2627
  * 1
2412
2628
  */
@@ -2423,7 +2639,15 @@ export declare class GetResourceOverviewResponseBodyDataGateway extends $dara.Mo
2423
2639
  });
2424
2640
  }
2425
2641
  export declare class GetResourceOverviewResponseBodyData extends $dara.Model {
2642
+ /**
2643
+ * @remarks
2644
+ * API information.
2645
+ */
2426
2646
  api?: GetResourceOverviewResponseBodyDataApi;
2647
+ /**
2648
+ * @remarks
2649
+ * Gateway information.
2650
+ */
2427
2651
  gateway?: GetResourceOverviewResponseBodyDataGateway;
2428
2652
  static names(): {
2429
2653
  [key: string]: string;
@@ -2438,26 +2662,47 @@ export declare class GetResourceOverviewResponseBodyData extends $dara.Model {
2438
2662
  }
2439
2663
  export declare class GetTraceConfigResponseBodyData extends $dara.Model {
2440
2664
  /**
2665
+ * @remarks
2666
+ * Whether to Enable Tracing:
2667
+ * true: Enabled
2668
+ * false: Disabled
2669
+ *
2441
2670
  * @example
2442
2671
  * true
2443
2672
  */
2444
2673
  enable?: boolean;
2445
2674
  /**
2675
+ * @remarks
2676
+ * Sampling Rate
2677
+ *
2446
2678
  * @example
2447
2679
  * 50
2448
2680
  */
2449
2681
  sampleRatio?: number;
2450
2682
  /**
2683
+ * @remarks
2684
+ * Service ID, present when the tracing type is SKYWALKING
2685
+ *
2451
2686
  * @example
2452
2687
  * ss-co370icmjeu****
2453
2688
  */
2454
2689
  serviceId?: string;
2455
2690
  /**
2691
+ * @remarks
2692
+ * 服务端口，链路追踪类型为SKYWALKING时存在该参数
2693
+ *
2456
2694
  * @example
2457
2695
  * 8090
2458
2696
  */
2459
2697
  servicePort?: string;
2460
2698
  /**
2699
+ * @remarks
2700
+ * Tracing Type:
2701
+ * - XTRACE
2702
+ * - SKYWALKING
2703
+ * - OPENTELEMETRY
2704
+ * - OTSKYWALKING
2705
+ *
2461
2706
  * @example
2462
2707
  * SKYWALKING
2463
2708
  */
@@ -2476,7 +2721,7 @@ export declare class GetTraceConfigResponseBodyData extends $dara.Model {
2476
2721
  export declare class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
2477
2722
  /**
2478
2723
  * @remarks
2479
- * The name of the Object Storage Service (OSS) bucket that stores the dictionary file.
2724
+ * The bucket name.
2480
2725
  *
2481
2726
  * @example
2482
2727
  * api-1
@@ -2484,7 +2729,7 @@ export declare class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
2484
2729
  bucketName?: string;
2485
2730
  /**
2486
2731
  * @remarks
2487
- * The file path.
2732
+ * The full path of the file.
2488
2733
  *
2489
2734
  * @example
2490
2735
  * /test/swagger.json
@@ -2512,15 +2757,15 @@ export declare class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
2512
2757
  export declare class ImportHttpApiResponseBodyDataDryRunInfoFailureComponents extends $dara.Model {
2513
2758
  /**
2514
2759
  * @remarks
2515
- * Error message.
2760
+ * The error message.
2516
2761
  *
2517
2762
  * @example
2518
- * 数据结构定义有误。
2763
+ * The data struct is incorrectly defined.
2519
2764
  */
2520
2765
  errorMessage?: string;
2521
2766
  /**
2522
2767
  * @remarks
2523
- * 数据结构名称。
2768
+ * The data struct name.
2524
2769
  *
2525
2770
  * @example
2526
2771
  * orderDTO
@@ -2540,15 +2785,15 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoFailureComponents ex
2540
2785
  export declare class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations extends $dara.Model {
2541
2786
  /**
2542
2787
  * @remarks
2543
- * Error message
2788
+ * The error message.
2544
2789
  *
2545
2790
  * @example
2546
- * 缺少响应定义。
2791
+ * Missing response definition.
2547
2792
  */
2548
2793
  errorMessage?: string;
2549
2794
  /**
2550
2795
  * @remarks
2551
- * API method.
2796
+ * The HTTP method of the operation.
2552
2797
  *
2553
2798
  * @example
2554
2799
  * GET
@@ -2556,7 +2801,7 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations ex
2556
2801
  method?: string;
2557
2802
  /**
2558
2803
  * @remarks
2559
- * API path.
2804
+ * The operation path.
2560
2805
  *
2561
2806
  * @example
2562
2807
  * /v1/orders
@@ -2576,9 +2821,10 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations ex
2576
2821
  export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents extends $dara.Model {
2577
2822
  /**
2578
2823
  * @remarks
2579
- * Action to be executed after the precheck.
2580
- * - Create: Create
2581
- * - Update: Update
2824
+ * The action that will be performed for the data struct after the dry run.
2825
+ *
2826
+ * * Create: The data struct is created.
2827
+ * * Update: The data struct is updated.
2582
2828
  *
2583
2829
  * @example
2584
2830
  * Create
@@ -2586,7 +2832,7 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents ex
2586
2832
  action?: string;
2587
2833
  /**
2588
2834
  * @remarks
2589
- * Data structure name.
2835
+ * The data struct name.
2590
2836
  *
2591
2837
  * @example
2592
2838
  * userDTO
@@ -2606,9 +2852,10 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents ex
2606
2852
  export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $dara.Model {
2607
2853
  /**
2608
2854
  * @remarks
2609
- * Action to be executed after the precheck.
2610
- * - Create: Create
2611
- * - Update: Update
2855
+ * The action that will be performed for the operation after the dry run.
2856
+ *
2857
+ * * Create: The operation is created.
2858
+ * * Update: The operation is updated.
2612
2859
  *
2613
2860
  * @example
2614
2861
  * Create
@@ -2616,7 +2863,7 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations ex
2616
2863
  action?: string;
2617
2864
  /**
2618
2865
  * @remarks
2619
- * API method.
2866
+ * The HTTP method of the operation.
2620
2867
  *
2621
2868
  * @example
2622
2869
  * POST
@@ -2624,7 +2871,7 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations ex
2624
2871
  method?: string;
2625
2872
  /**
2626
2873
  * @remarks
2627
- * API name.
2874
+ * The operation name.
2628
2875
  *
2629
2876
  * @example
2630
2877
  * CreateUser
@@ -2632,7 +2879,7 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations ex
2632
2879
  name?: string;
2633
2880
  /**
2634
2881
  * @remarks
2635
- * API path.
2882
+ * The operation path.
2636
2883
  *
2637
2884
  * @example
2638
2885
  * /v1/users
@@ -2652,37 +2899,37 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations ex
2652
2899
  export declare class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
2653
2900
  /**
2654
2901
  * @remarks
2655
- * Error messages. If there are any error messages, the API cannot be imported successfully.
2902
+ * The error messages. If an error message is returned, the API fails to be imported.
2656
2903
  */
2657
2904
  errorMessages?: string[];
2658
2905
  /**
2659
2906
  * @remarks
2660
- * 已存在的API信息。若该字段非空，则导入动作将更新该API。
2907
+ * The existing APIs. If an existing API is returned, the import updates the existing API.
2661
2908
  */
2662
2909
  existHttpApiInfo?: HttpApiApiInfo;
2663
2910
  /**
2664
2911
  * @remarks
2665
- * List of data structures that failed the precheck.
2912
+ * The data structs that fail the dry run.
2666
2913
  */
2667
2914
  failureComponents?: ImportHttpApiResponseBodyDataDryRunInfoFailureComponents[];
2668
2915
  /**
2669
2916
  * @remarks
2670
- * List of APIs that failed the precheck.
2917
+ * The operations that fail the dry run.
2671
2918
  */
2672
2919
  failureOperations?: ImportHttpApiResponseBodyDataDryRunInfoFailureOperations[];
2673
2920
  /**
2674
2921
  * @remarks
2675
- * List of data structures that passed the precheck.
2922
+ * The data structs that pass the dry run.
2676
2923
  */
2677
2924
  successComponents?: ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents[];
2678
2925
  /**
2679
2926
  * @remarks
2680
- * List of successfully pre-checked interfaces.
2927
+ * The operations that pass the dry run.
2681
2928
  */
2682
2929
  successOperations?: ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations[];
2683
2930
  /**
2684
2931
  * @remarks
2685
- * Warning messages. If there are any warning messages, some interfaces or data interfaces may not be imported successfully.
2932
+ * The alerts. If an alert is returned, specific operations or structs may fail to be imported.
2686
2933
  */
2687
2934
  warningMessages?: string[];
2688
2935
  static names(): {
@@ -2699,12 +2946,12 @@ export declare class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model
2699
2946
  export declare class ImportHttpApiResponseBodyData extends $dara.Model {
2700
2947
  /**
2701
2948
  * @remarks
2702
- * Pre-import check result.
2949
+ * The dry run result.
2703
2950
  */
2704
2951
  dryRunInfo?: ImportHttpApiResponseBodyDataDryRunInfo;
2705
2952
  /**
2706
2953
  * @remarks
2707
- * HTTP API ID.
2954
+ * The API ID.
2708
2955
  *
2709
2956
  * @example
2710
2957
  * api-xxx
@@ -2712,7 +2959,7 @@ export declare class ImportHttpApiResponseBodyData extends $dara.Model {
2712
2959
  httpApiId?: string;
2713
2960
  /**
2714
2961
  * @remarks
2715
- * API name.
2962
+ * The API name.
2716
2963
  *
2717
2964
  * @example
2718
2965
  * import-test
@@ -2732,12 +2979,12 @@ export declare class ImportHttpApiResponseBodyData extends $dara.Model {
2732
2979
  export declare class ListDomainsResponseBodyData extends $dara.Model {
2733
2980
  /**
2734
2981
  * @remarks
2735
- * List of domain information.
2982
+ * The information about the domain names.
2736
2983
  */
2737
2984
  items?: DomainInfo[];
2738
2985
  /**
2739
2986
  * @remarks
2740
- * Page number.
2987
+ * The page number of the returned page.
2741
2988
  *
2742
2989
  * @example
2743
2990
  * 1
@@ -2745,7 +2992,7 @@ export declare class ListDomainsResponseBodyData extends $dara.Model {
2745
2992
  pageNumber?: number;
2746
2993
  /**
2747
2994
  * @remarks
2748
- * Number of items per page.
2995
+ * The number of entries per page.
2749
2996
  *
2750
2997
  * @example
2751
2998
  * 10
@@ -2753,7 +3000,7 @@ export declare class ListDomainsResponseBodyData extends $dara.Model {
2753
3000
  pageSize?: number;
2754
3001
  /**
2755
3002
  * @remarks
2756
- * Total number of items.
3003
+ * The total number of entries returned.
2757
3004
  *
2758
3005
  * @example
2759
3006
  * 9
@@ -2814,7 +3061,7 @@ export declare class ListEnvironmentsResponseBodyData extends $dara.Model {
2814
3061
  export declare class ListGatewaysRequestTag extends $dara.Model {
2815
3062
  /**
2816
3063
  * @remarks
2817
- * The key of the tag.
3064
+ * The key of tag N.
2818
3065
  *
2819
3066
  * @example
2820
3067
  * owner
@@ -2822,7 +3069,7 @@ export declare class ListGatewaysRequestTag extends $dara.Model {
2822
3069
  key?: string;
2823
3070
  /**
2824
3071
  * @remarks
2825
- * The value of the tag.
3072
+ * The value of tag N.
2826
3073
  *
2827
3074
  * @example
2828
3075
  * zhangsan
@@ -2842,7 +3089,7 @@ export declare class ListGatewaysRequestTag extends $dara.Model {
2842
3089
  export declare class ListGatewaysResponseBodyDataItemsLoadBalancersPorts extends $dara.Model {
2843
3090
  /**
2844
3091
  * @remarks
2845
- * Port number.
3092
+ * The port number.
2846
3093
  *
2847
3094
  * @example
2848
3095
  * 443
@@ -2850,9 +3097,10 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancersPorts extends
2850
3097
  port?: number;
2851
3098
  /**
2852
3099
  * @remarks
2853
- * Protocol:
2854
- * - TCP
2855
- * - UDP
3100
+ * The protocol. Valid values:
3101
+ *
3102
+ * * TCP
3103
+ * * UDP
2856
3104
  *
2857
3105
  * @example
2858
3106
  * TCP
@@ -2872,7 +3120,7 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancersPorts extends
2872
3120
  export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dara.Model {
2873
3121
  /**
2874
3122
  * @remarks
2875
- * Load balancer address.
3123
+ * The load balancer IP address.
2876
3124
  *
2877
3125
  * @example
2878
3126
  * nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com
@@ -2880,9 +3128,10 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2880
3128
  address?: string;
2881
3129
  /**
2882
3130
  * @remarks
2883
- * IP version:
2884
- * - ipv4: IPv4.
2885
- * - ipv6: IPv6.
3131
+ * The IP version of the address. Valid values:
3132
+ *
3133
+ * * ipv4: IPv4
3134
+ * * ipv6: IPv6
2886
3135
  *
2887
3136
  * @example
2888
3137
  * ipv4
@@ -2890,9 +3139,10 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2890
3139
  addressIpVersion?: string;
2891
3140
  /**
2892
3141
  * @remarks
2893
- * Load balancer address type:
2894
- * - Internet: Public network.
2895
- * - Intranet: Private network.
3142
+ * The address type. Valid values:
3143
+ *
3144
+ * * Internet
3145
+ * * Intranet
2896
3146
  *
2897
3147
  * @example
2898
3148
  * Internet
@@ -2900,7 +3150,7 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2900
3150
  addressType?: string;
2901
3151
  /**
2902
3152
  * @remarks
2903
- * Indicates whether this is the default entry address for the gateway.
3153
+ * Indicates whether the address is the default ingress address of the instance.
2904
3154
  *
2905
3155
  * @example
2906
3156
  * true
@@ -2908,7 +3158,7 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2908
3158
  gatewayDefault?: boolean;
2909
3159
  /**
2910
3160
  * @remarks
2911
- * Load balancer ID.
3161
+ * The load balancer ID.
2912
3162
  *
2913
3163
  * @example
2914
3164
  * nlb-xqwioje1c91r***
@@ -2916,8 +3166,9 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2916
3166
  loadBalancerId?: string;
2917
3167
  /**
2918
3168
  * @remarks
2919
- * Load balancer provision mode for the gateway:
2920
- * - Managed: Managed by the Cloud Native API Gateway.
3169
+ * The mode in which the load balancer is provided. Valid values:
3170
+ *
3171
+ * * Managed: Cloud-native API Gateway manages and provides the load balancer.
2921
3172
  *
2922
3173
  * @example
2923
3174
  * Managed
@@ -2925,14 +3176,15 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2925
3176
  mode?: string;
2926
3177
  /**
2927
3178
  * @remarks
2928
- * List of listening ports.
3179
+ * The list of listened ports.
2929
3180
  */
2930
3181
  ports?: ListGatewaysResponseBodyDataItemsLoadBalancersPorts[];
2931
3182
  /**
2932
3183
  * @remarks
2933
- * Status of the load balancer:
2934
- * - Ready: Available.
2935
- * - NotCreate: No associated instance.
3184
+ * The load balancer status. Valid values:
3185
+ *
3186
+ * * Ready: The load balancer is available.
3187
+ * * NotCreate: The load balancer is not associated with the instance.
2936
3188
  *
2937
3189
  * @example
2938
3190
  * Ready
@@ -2940,9 +3192,10 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2940
3192
  status?: string;
2941
3193
  /**
2942
3194
  * @remarks
2943
- * Type of load balancer for the gateway:
2944
- * - NLB: Network Load Balancer.
2945
- * - CLB: Classic Load Balancer.
3195
+ * The load balancer type. Valid values:
3196
+ *
3197
+ * * NLB: Network Load Balancer
3198
+ * * CLB: Classic Load Balancer
2946
3199
  *
2947
3200
  * @example
2948
3201
  * NLB
@@ -2962,7 +3215,7 @@ export declare class ListGatewaysResponseBodyDataItemsLoadBalancers extends $dar
2962
3215
  export declare class ListGatewaysResponseBodyDataItemsSecurityGroup extends $dara.Model {
2963
3216
  /**
2964
3217
  * @remarks
2965
- * The Security Group ID.
3218
+ * The security group ID.
2966
3219
  *
2967
3220
  * @example
2968
3221
  * sg-xxxx
@@ -2982,7 +3235,7 @@ export declare class ListGatewaysResponseBodyDataItemsSecurityGroup extends $dar
2982
3235
  export declare class ListGatewaysResponseBodyDataItemsTags extends $dara.Model {
2983
3236
  /**
2984
3237
  * @remarks
2985
- * The key of the tag.
3238
+ * The tag key.
2986
3239
  *
2987
3240
  * @example
2988
3241
  * owner
@@ -2990,7 +3243,7 @@ export declare class ListGatewaysResponseBodyDataItemsTags extends $dara.Model {
2990
3243
  key?: string;
2991
3244
  /**
2992
3245
  * @remarks
2993
- * The value of the tag.
3246
+ * The tag value.
2994
3247
  *
2995
3248
  * @example
2996
3249
  * zhangsan
@@ -3070,12 +3323,12 @@ export declare class ListGatewaysResponseBodyDataItemsZonesVSwitch extends $dara
3070
3323
  export declare class ListGatewaysResponseBodyDataItemsZones extends $dara.Model {
3071
3324
  /**
3072
3325
  * @remarks
3073
- * The vSwitch.
3326
+ * The vSwitch information.
3074
3327
  */
3075
3328
  vSwitch?: ListGatewaysResponseBodyDataItemsZonesVSwitch;
3076
3329
  /**
3077
3330
  * @remarks
3078
- * The ID of the current zone.
3331
+ * The zone ID.
3079
3332
  *
3080
3333
  * @example
3081
3334
  * cn-hangzhou-f
@@ -3095,10 +3348,10 @@ export declare class ListGatewaysResponseBodyDataItemsZones extends $dara.Model
3095
3348
  export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3096
3349
  /**
3097
3350
  * @remarks
3098
- * Charge type
3351
+ * The billing method. Valid values:
3099
3352
  *
3100
- * - POSTPAY: Postpaid (pay-as-you-go)
3101
- * - PREPAY: Prepaid (subscription)
3353
+ * * POSTPAY: pay-as-you-go
3354
+ * * PREPAY: subscription
3102
3355
  *
3103
3356
  * @example
3104
3357
  * POSTPAY
@@ -3106,8 +3359,9 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3106
3359
  chargeType?: string;
3107
3360
  /**
3108
3361
  * @remarks
3109
- * Source of gateway creation:
3110
- * - Console: Console.
3362
+ * The creation source of the instance. Valid values:
3363
+ *
3364
+ * * Console
3111
3365
  *
3112
3366
  * @example
3113
3367
  * Console
@@ -3115,7 +3369,7 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3115
3369
  createFrom?: string;
3116
3370
  /**
3117
3371
  * @remarks
3118
- * Creation timestamp, in milliseconds.
3372
+ * The time when the instance was created. This value is a UNIX timestamp. Unit: milliseconds.
3119
3373
  *
3120
3374
  * @example
3121
3375
  * 1719386834548
@@ -3123,7 +3377,7 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3123
3377
  createTimestamp?: number;
3124
3378
  /**
3125
3379
  * @remarks
3126
- * Expiration timestamp for prepaid (annual or monthly) subscriptions. Unit: milliseconds.
3380
+ * The time when the instance expires. This value is a UNIX timestamp. Unit: milliseconds.
3127
3381
  *
3128
3382
  * @example
3129
3383
  * 172086834548
@@ -3131,7 +3385,7 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3131
3385
  expireTimestamp?: number;
3132
3386
  /**
3133
3387
  * @remarks
3134
- * Gateway ID.
3388
+ * The instance ID.
3135
3389
  *
3136
3390
  * @example
3137
3391
  * gw-cpv54p5***
@@ -3139,12 +3393,12 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3139
3393
  gatewayId?: string;
3140
3394
  /**
3141
3395
  * @remarks
3142
- * List of gateway entry addresses.
3396
+ * The ingress addresses of the instance.
3143
3397
  */
3144
3398
  loadBalancers?: ListGatewaysResponseBodyDataItemsLoadBalancers[];
3145
3399
  /**
3146
3400
  * @remarks
3147
- * Gateway name.
3401
+ * The instance name.
3148
3402
  *
3149
3403
  * @example
3150
3404
  * itemcenter-gateway
@@ -3152,7 +3406,7 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3152
3406
  name?: string;
3153
3407
  /**
3154
3408
  * @remarks
3155
- * Number of gateway instance nodes.
3409
+ * The node quantity of the instance.
3156
3410
  *
3157
3411
  * @example
3158
3412
  * 2
@@ -3160,7 +3414,7 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3160
3414
  replicas?: string;
3161
3415
  /**
3162
3416
  * @remarks
3163
- * Resource group ID.
3417
+ * The resource group ID.
3164
3418
  *
3165
3419
  * @example
3166
3420
  * rg-xxx
@@ -3168,13 +3422,14 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3168
3422
  resourceGroupId?: string;
3169
3423
  /**
3170
3424
  * @remarks
3171
- * The Security Group.
3425
+ * The security group information about the instance.
3172
3426
  */
3173
3427
  securityGroup?: ListGatewaysResponseBodyDataItemsSecurityGroup;
3174
3428
  /**
3175
3429
  * @remarks
3176
- * Gateway specification:
3177
- * - apigw.small.x1: Small specification.
3430
+ * The instance specification. Valid values:
3431
+ *
3432
+ * * apigw.small.x1
3178
3433
  *
3179
3434
  * @example
3180
3435
  * apigw.small.x1
@@ -3182,30 +3437,35 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3182
3437
  spec?: string;
3183
3438
  /**
3184
3439
  * @remarks
3185
- * Gateway status:
3186
- * - Running: Running.
3187
- * - Creating: Creating.
3188
- * - CreateFailed: Creation failed.
3189
- * - Upgrading: Upgrading.
3190
- * - UpgradeFailed: Upgrade failed.
3191
- * - Restarting: Restarting.
3192
- * - RestartFailed: Restart failed.
3193
- * - Deleting: Deleting.
3194
- * - DeleteFailed: Deletion failed.
3440
+ * The instance state. Valid values:
3441
+ *
3442
+ * * Running: The instance is running.
3443
+ * * Creating: The instance is being created.
3444
+ * * CreateFailed: The instance fails to be created.
3445
+ * * Upgrading: The instance is being upgraded.
3446
+ * * UpgradeFailed: The instance fails to be upgraded.
3447
+ * * Restarting: The instance is being restarted.
3448
+ * * RestartFailed: The instance fails to be restarted.
3449
+ * * Deleting: The instance is being released.
3450
+ * * DeleteFailed: The instance failed to be released.
3195
3451
  *
3196
3452
  * @example
3197
3453
  * Running
3198
3454
  */
3199
3455
  status?: string;
3456
+ /**
3457
+ * @remarks
3458
+ * The second-level domain names.
3459
+ */
3200
3460
  subDomainInfos?: SubDomainInfo[];
3201
3461
  /**
3202
3462
  * @remarks
3203
- * Array of tags.
3463
+ * The tags.
3204
3464
  */
3205
3465
  tags?: ListGatewaysResponseBodyDataItemsTags[];
3206
3466
  /**
3207
3467
  * @remarks
3208
- * Target version of the gateway. When it is inconsistent with the current `version`, an upgrade can be performed.
3468
+ * The destination version of the instance. If the value is inconsistent with the current version, you can upgrade the instance.
3209
3469
  *
3210
3470
  * @example
3211
3471
  * 2.0.2
@@ -3213,7 +3473,7 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3213
3473
  targetVersion?: string;
3214
3474
  /**
3215
3475
  * @remarks
3216
- * Update timestamp. Unit: milliseconds.
3476
+ * The time when the instance was last updated. This value is a UNIX timestamp. Unit: milliseconds.
3217
3477
  *
3218
3478
  * @example
3219
3479
  * 1719386834548
@@ -3221,12 +3481,12 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3221
3481
  updateTimestamp?: number;
3222
3482
  /**
3223
3483
  * @remarks
3224
- * The vSwtich.
3484
+ * The vSwitch information.
3225
3485
  */
3226
3486
  vSwitch?: ListGatewaysResponseBodyDataItemsVSwitch;
3227
3487
  /**
3228
3488
  * @remarks
3229
- * Gateway version.
3489
+ * The instance version.
3230
3490
  *
3231
3491
  * @example
3232
3492
  * 2.0.2
@@ -3234,12 +3494,12 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3234
3494
  version?: string;
3235
3495
  /**
3236
3496
  * @remarks
3237
- * The VPC.
3497
+ * The virtual private cloud (VPC) information of the instance.
3238
3498
  */
3239
3499
  vpc?: ListGatewaysResponseBodyDataItemsVpc;
3240
3500
  /**
3241
3501
  * @remarks
3242
- * The Zones.
3502
+ * The availability zones of the instance.
3243
3503
  */
3244
3504
  zones?: ListGatewaysResponseBodyDataItemsZones[];
3245
3505
  static names(): {
@@ -3256,12 +3516,12 @@ export declare class ListGatewaysResponseBodyDataItems extends $dara.Model {
3256
3516
  export declare class ListGatewaysResponseBodyData extends $dara.Model {
3257
3517
  /**
3258
3518
  * @remarks
3259
- * Gateway list
3519
+ * The instances.
3260
3520
  */
3261
3521
  items?: ListGatewaysResponseBodyDataItems[];
3262
3522
  /**
3263
3523
  * @remarks
3264
- * Page number.
3524
+ * The page number of the returned page.
3265
3525
  *
3266
3526
  * @example
3267
3527
  * 1
@@ -3269,7 +3529,7 @@ export declare class ListGatewaysResponseBodyData extends $dara.Model {
3269
3529
  pageNumber?: number;
3270
3530
  /**
3271
3531
  * @remarks
3272
- * Page size.
3532
+ * The number of entries per page.
3273
3533
  *
3274
3534
  * @example
3275
3535
  * 10
@@ -3277,7 +3537,7 @@ export declare class ListGatewaysResponseBodyData extends $dara.Model {
3277
3537
  pageSize?: number;
3278
3538
  /**
3279
3539
  * @remarks
3280
- * Total count.
3540
+ * The total number of entries returned.
3281
3541
  *
3282
3542
  * @example
3283
3543
  * 6
@@ -3336,18 +3596,31 @@ export declare class ListHttpApiOperationsResponseBodyData extends $dara.Model {
3336
3596
  });
3337
3597
  }
3338
3598
  export declare class ListHttpApiRoutesResponseBodyData extends $dara.Model {
3599
+ /**
3600
+ * @remarks
3601
+ * The routes.
3602
+ */
3339
3603
  items?: HttpRoute[];
3340
3604
  /**
3605
+ * @remarks
3606
+ * The page number of the returned page.
3607
+ *
3341
3608
  * @example
3342
3609
  * 1
3343
3610
  */
3344
3611
  pageNumber?: number;
3345
3612
  /**
3613
+ * @remarks
3614
+ * The number of entries per page.
3615
+ *
3346
3616
  * @example
3347
3617
  * 20
3348
3618
  */
3349
3619
  pageSize?: number;
3350
3620
  /**
3621
+ * @remarks
3622
+ * The total number of entries returned.
3623
+ *
3351
3624
  * @example
3352
3625
  * 9
3353
3626
  */
@@ -3366,12 +3639,12 @@ export declare class ListHttpApiRoutesResponseBodyData extends $dara.Model {
3366
3639
  export declare class ListHttpApisResponseBodyData extends $dara.Model {
3367
3640
  /**
3368
3641
  * @remarks
3369
- * API information.
3642
+ * The API information.
3370
3643
  */
3371
3644
  items?: HttpApiInfoByName[];
3372
3645
  /**
3373
3646
  * @remarks
3374
- * Page number.
3647
+ * The page number of the returned page.
3375
3648
  *
3376
3649
  * @example
3377
3650
  * 1
@@ -3379,7 +3652,7 @@ export declare class ListHttpApisResponseBodyData extends $dara.Model {
3379
3652
  pageNumber?: number;
3380
3653
  /**
3381
3654
  * @remarks
3382
- * Page size.
3655
+ * The number of entries per page.
3383
3656
  *
3384
3657
  * @example
3385
3658
  * 10
@@ -3387,7 +3660,7 @@ export declare class ListHttpApisResponseBodyData extends $dara.Model {
3387
3660
  pageSize?: number;
3388
3661
  /**
3389
3662
  * @remarks
3390
- * Total count.
3663
+ * The total number of entries returned.
3391
3664
  *
3392
3665
  * @example
3393
3666
  * 10
@@ -3405,18 +3678,31 @@ export declare class ListHttpApisResponseBodyData extends $dara.Model {
3405
3678
  });
3406
3679
  }
3407
3680
  export declare class ListPolicyClassesResponseBodyData extends $dara.Model {
3681
+ /**
3682
+ * @remarks
3683
+ * List of policy templates
3684
+ */
3408
3685
  items?: PolicyClassInfo[];
3409
3686
  /**
3687
+ * @remarks
3688
+ * Page number.
3689
+ *
3410
3690
  * @example
3411
3691
  * 1
3412
3692
  */
3413
3693
  pageNumber?: number;
3414
3694
  /**
3695
+ * @remarks
3696
+ * Page size
3697
+ *
3415
3698
  * @example
3416
3699
  * 10
3417
3700
  */
3418
3701
  pageSize?: number;
3419
3702
  /**
3703
+ * @remarks
3704
+ * Total number of items.
3705
+ *
3420
3706
  * @example
3421
3707
  * 10
3422
3708
  */
@@ -3433,18 +3719,31 @@ export declare class ListPolicyClassesResponseBodyData extends $dara.Model {
3433
3719
  });
3434
3720
  }
3435
3721
  export declare class ListServicesResponseBodyData extends $dara.Model {
3436
- items?: Service[];
3437
3722
  /**
3438
- * @example
3439
- * 1
3723
+ * @remarks
3724
+ * The services.
3725
+ */
3726
+ items?: Service[];
3727
+ /**
3728
+ * @remarks
3729
+ * The page number of the returned page.
3730
+ *
3731
+ * @example
3732
+ * 1
3440
3733
  */
3441
3734
  pageNumber?: number;
3442
3735
  /**
3736
+ * @remarks
3737
+ * The number of entries per page.
3738
+ *
3443
3739
  * @example
3444
3740
  * 10
3445
3741
  */
3446
3742
  pageSize?: number;
3447
3743
  /**
3744
+ * @remarks
3745
+ * The total number of entries returned.
3746
+ *
3448
3747
  * @example
3449
3748
  * 18
3450
3749
  */
@@ -3461,18 +3760,31 @@ export declare class ListServicesResponseBodyData extends $dara.Model {
3461
3760
  });
3462
3761
  }
3463
3762
  export declare class ListSslCertsResponseBodyData extends $dara.Model {
3763
+ /**
3764
+ * @remarks
3765
+ * List of certificate information.
3766
+ */
3464
3767
  items?: SslCertMetaInfo[];
3465
3768
  /**
3769
+ * @remarks
3770
+ * Page number.
3771
+ *
3466
3772
  * @example
3467
3773
  * 1
3468
3774
  */
3469
3775
  pageNumber?: number;
3470
3776
  /**
3777
+ * @remarks
3778
+ * Page size.
3779
+ *
3471
3780
  * @example
3472
3781
  * 10
3473
3782
  */
3474
3783
  pageSize?: number;
3475
3784
  /**
3785
+ * @remarks
3786
+ * Total count.
3787
+ *
3476
3788
  * @example
3477
3789
  * 2
3478
3790
  */
@@ -3490,6 +3802,9 @@ export declare class ListSslCertsResponseBodyData extends $dara.Model {
3490
3802
  }
3491
3803
  export declare class ListZonesResponseBodyDataItems extends $dara.Model {
3492
3804
  /**
3805
+ * @remarks
3806
+ * 可用区ID。
3807
+ *
3493
3808
  * @example
3494
3809
  * cn-shenzhen-c
3495
3810
  */
@@ -3506,6 +3821,10 @@ export declare class ListZonesResponseBodyDataItems extends $dara.Model {
3506
3821
  });
3507
3822
  }
3508
3823
  export declare class ListZonesResponseBodyData extends $dara.Model {
3824
+ /**
3825
+ * @remarks
3826
+ * List of availability zones.
3827
+ */
3509
3828
  items?: ListZonesResponseBodyDataItems[];
3510
3829
  static names(): {
3511
3830
  [key: string]: string;
@@ -3521,7 +3840,7 @@ export declare class ListZonesResponseBodyData extends $dara.Model {
3521
3840
  export declare class UpdateDomainResponseBodyData extends $dara.Model {
3522
3841
  /**
3523
3842
  * @remarks
3524
- * Deploy revision id.
3843
+ * The released version ID.
3525
3844
  *
3526
3845
  * @example
3527
3846
  * apr-xxx
@@ -3541,7 +3860,7 @@ export declare class UpdateDomainResponseBodyData extends $dara.Model {
3541
3860
  export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
3542
3861
  /**
3543
3862
  * @remarks
3544
- * Environment ID.
3863
+ * The environment ID.
3545
3864
  *
3546
3865
  * @example
3547
3866
  * env-cr6ql0tlhtgmc****
@@ -3549,7 +3868,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
3549
3868
  environmentId?: string;
3550
3869
  /**
3551
3870
  * @remarks
3552
- * Ingress Class being listened to.
3871
+ * The Ingress class for listening.
3553
3872
  *
3554
3873
  * @example
3555
3874
  * mse
@@ -3557,7 +3876,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
3557
3876
  ingressClass?: string;
3558
3877
  /**
3559
3878
  * @remarks
3560
- * Whether to update the address in the Ingress Status.
3879
+ * Specifies whether to update the address in Ingress Status.
3561
3880
  *
3562
3881
  * @example
3563
3882
  * false
@@ -3565,7 +3884,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
3565
3884
  overrideIngressIp?: boolean;
3566
3885
  /**
3567
3886
  * @remarks
3568
- * Source ID.
3887
+ * The source ID.
3569
3888
  *
3570
3889
  * @example
3571
3890
  * src-crdddallhtgtr****
@@ -3573,7 +3892,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
3573
3892
  sourceId?: string;
3574
3893
  /**
3575
3894
  * @remarks
3576
- * Watched namespace.
3895
+ * The namespace for listening.
3577
3896
  *
3578
3897
  * @example
3579
3898
  * default
@@ -3593,7 +3912,7 @@ export declare class UpdateHttpApiRequestIngressConfig extends $dara.Model {
3593
3912
  export declare class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model {
3594
3913
  /**
3595
3914
  * @remarks
3596
- * Service port, do not pass in for dynamic ports.
3915
+ * The service port. If you want to use a dynamic port, do not pass this parameter.
3597
3916
  *
3598
3917
  * @example
3599
3918
  * 8080
@@ -3601,9 +3920,10 @@ export declare class UpdateHttpApiRouteRequestBackendConfigServices extends $dar
3601
3920
  port?: number;
3602
3921
  /**
3603
3922
  * @remarks
3604
- * Service protocol:
3605
- * - HTTP.
3606
- * - HTTPS.
3923
+ * The protocol. Valid values:
3924
+ *
3925
+ * * HTTP
3926
+ * * HTTPS
3607
3927
  *
3608
3928
  * @example
3609
3929
  * HTTP
@@ -3611,7 +3931,7 @@ export declare class UpdateHttpApiRouteRequestBackendConfigServices extends $dar
3611
3931
  protocol?: string;
3612
3932
  /**
3613
3933
  * @remarks
3614
- * Service ID.
3934
+ * The service ID.
3615
3935
  *
3616
3936
  * @example
3617
3937
  * svc-cr6pk4tlhtgm58e***
@@ -3619,7 +3939,7 @@ export declare class UpdateHttpApiRouteRequestBackendConfigServices extends $dar
3619
3939
  serviceId?: string;
3620
3940
  /**
3621
3941
  * @remarks
3622
- * Service version.
3942
+ * The service version.
3623
3943
  *
3624
3944
  * @example
3625
3945
  * v1
@@ -3627,7 +3947,7 @@ export declare class UpdateHttpApiRouteRequestBackendConfigServices extends $dar
3627
3947
  version?: string;
3628
3948
  /**
3629
3949
  * @remarks
3630
- * Percentage value of traffic ratio.
3950
+ * The percentage value of traffic.
3631
3951
  *
3632
3952
  * @example
3633
3953
  * 49
@@ -3647,7 +3967,14 @@ export declare class UpdateHttpApiRouteRequestBackendConfigServices extends $dar
3647
3967
  export declare class UpdateHttpApiRouteRequestBackendConfig extends $dara.Model {
3648
3968
  /**
3649
3969
  * @remarks
3650
- * Backend service scenario.
3970
+ * The backend service scenario.
3971
+ *
3972
+ * Valid values:
3973
+ *
3974
+ * * SingleService
3975
+ * * MultiServiceByRatio
3976
+ * * Redirect
3977
+ * * Mock
3651
3978
  *
3652
3979
  * @example
3653
3980
  * SingleService
@@ -3655,7 +3982,7 @@ export declare class UpdateHttpApiRouteRequestBackendConfig extends $dara.Model
3655
3982
  scene?: string;
3656
3983
  /**
3657
3984
  * @remarks
3658
- * List of backend services.
3985
+ * The backend services.
3659
3986
  */
3660
3987
  services?: UpdateHttpApiRouteRequestBackendConfigServices[];
3661
3988
  static names(): {
@@ -3850,10 +4177,12 @@ export declare class DashboardFilter extends $dara.Model {
3850
4177
  }
3851
4178
  export declare class DomainInfo extends $dara.Model {
3852
4179
  certIdentifier?: string;
4180
+ clientCACert?: string;
3853
4181
  createFrom?: string;
3854
4182
  createTimestamp?: number;
3855
4183
  domainId?: string;
3856
4184
  forceHttps?: boolean;
4185
+ mTLSEnabled?: boolean;
3857
4186
  name?: string;
3858
4187
  protocol?: string;
3859
4188
  /**
@@ -4883,21 +5212,33 @@ export declare class AddGatewaySecurityGroupRuleResponse extends $dara.Model {
4883
5212
  }
4884
5213
  export declare class ChangeResourceGroupRequest extends $dara.Model {
4885
5214
  /**
5215
+ * @remarks
5216
+ * Target resource group ID.
5217
+ *
4886
5218
  * @example
4887
5219
  * rg-aekzdrfx2xdnaja
4888
5220
  */
4889
5221
  resourceGroupId?: string;
4890
5222
  /**
5223
+ * @remarks
5224
+ * Resource ID
5225
+ *
4891
5226
  * @example
4892
5227
  * gw-ct4i14um1hkn0tpqfae0
4893
5228
  */
4894
5229
  resourceId?: string;
4895
5230
  /**
5231
+ * @remarks
5232
+ * Resource type
5233
+ *
4896
5234
  * @example
4897
5235
  * gateway
4898
5236
  */
4899
5237
  resourceType?: string;
4900
5238
  /**
5239
+ * @remarks
5240
+ * Service name, fixed value apig
5241
+ *
4901
5242
  * @example
4902
5243
  * apig
4903
5244
  */
@@ -4915,6 +5256,9 @@ export declare class ChangeResourceGroupRequest extends $dara.Model {
4915
5256
  }
4916
5257
  export declare class ChangeResourceGroupResponseBody extends $dara.Model {
4917
5258
  /**
5259
+ * @remarks
5260
+ * Request ID.
5261
+ *
4918
5262
  * @example
4919
5263
  * 59F86F37-787A-52DB-9475-DB5A255517F0
4920
5264
  */
@@ -4950,7 +5294,7 @@ export declare class ChangeResourceGroupResponse extends $dara.Model {
4950
5294
  export declare class CreateDomainRequest extends $dara.Model {
4951
5295
  /**
4952
5296
  * @remarks
4953
- * CA Certificate Identifier.
5297
+ * The CA certificate ID.
4954
5298
  *
4955
5299
  * @example
4956
5300
  * 1ef1da5f-38ed-69b3-****-037781890265
@@ -4958,7 +5302,7 @@ export declare class CreateDomainRequest extends $dara.Model {
4958
5302
  caCertIdentifier?: string;
4959
5303
  /**
4960
5304
  * @remarks
4961
- * Certificate Unique Identifier.
5305
+ * The certificate ID.
4962
5306
  *
4963
5307
  * @example
4964
5308
  * 1ef1da5f-38ed-69b3-****-037781890265
@@ -4966,7 +5310,19 @@ export declare class CreateDomainRequest extends $dara.Model {
4966
5310
  certIdentifier?: string;
4967
5311
  /**
4968
5312
  * @remarks
4969
- * Set the HTTPS protocol type, whether to enable forced HTTPS redirection.
5313
+ * The client CA certificate.
5314
+ *
5315
+ * @example
5316
+ * -----BEGIN CERTIFICATE-----
5317
+ * MIIFBTCCAu2gAwIBAgIUORLpYPGSFD1YOP6PMbE7Wd/mpTQwDQYJKoZIhvcNAQEL
5318
+ * BQAwE************************************************2VwVOJ2gqX3
5319
+ * YuGaxvIbDy0iQJ1GMerPRyzJTeVEtdIKT29u0PdFRr4KZWom35qX7G4=
5320
+ * -----END CERTIFICATE-----
5321
+ */
5322
+ clientCACert?: string;
5323
+ /**
5324
+ * @remarks
5325
+ * Specifies whether to enable forcible HTTPS redirection.
4970
5326
  *
4971
5327
  * @example
4972
5328
  * false
@@ -4974,7 +5330,13 @@ export declare class CreateDomainRequest extends $dara.Model {
4974
5330
  forceHttps?: boolean;
4975
5331
  /**
4976
5332
  * @remarks
4977
- * HTTP/2 settings.
5333
+ * The HTTP/2 configuration.
5334
+ *
5335
+ * Valid values:
5336
+ *
5337
+ * * GlobalConfig
5338
+ * * Close
5339
+ * * Open
4978
5340
  *
4979
5341
  * @example
4980
5342
  * Open
@@ -4982,7 +5344,12 @@ export declare class CreateDomainRequest extends $dara.Model {
4982
5344
  http2Option?: string;
4983
5345
  /**
4984
5346
  * @remarks
4985
- * Domain name.
5347
+ * Specifies whether to enable mutual authentication.
5348
+ */
5349
+ mTLSEnabled?: boolean;
5350
+ /**
5351
+ * @remarks
5352
+ * The domain name.
4986
5353
  *
4987
5354
  * This parameter is required.
4988
5355
  *
@@ -4992,10 +5359,10 @@ export declare class CreateDomainRequest extends $dara.Model {
4992
5359
  name?: string;
4993
5360
  /**
4994
5361
  * @remarks
4995
- * The protocol type supported by the domain.
5362
+ * The protocol type supported by the domain name.
4996
5363
  *
4997
- * - HTTP: Supports only HTTP protocol.
4998
- * - HTTPS: Supports only HTTPS protocol.
5364
+ * * HTTP: Only HTTP is supported.
5365
+ * * HTTPS: Only HTTPS is supported.
4999
5366
  *
5000
5367
  * This parameter is required.
5001
5368
  *
@@ -5005,7 +5372,7 @@ export declare class CreateDomainRequest extends $dara.Model {
5005
5372
  protocol?: string;
5006
5373
  /**
5007
5374
  * @remarks
5008
- * The ID of the resource group.
5375
+ * The [resource group ID](https://help.aliyun.com/document_detail/151181.html).
5009
5376
  *
5010
5377
  * @example
5011
5378
  * rg-aekzoiafjtr7zyq
@@ -5013,12 +5380,12 @@ export declare class CreateDomainRequest extends $dara.Model {
5013
5380
  resourceGroupId?: string;
5014
5381
  /**
5015
5382
  * @remarks
5016
- * The TLS cipher suites config.
5383
+ * The cipher suite configuration.
5017
5384
  */
5018
5385
  tlsCipherSuitesConfig?: TlsCipherSuitesConfig;
5019
5386
  /**
5020
5387
  * @remarks
5021
- * Maximum TLS protocol version, supports up to TLS 1.3.
5388
+ * The maximum version of the TLS protocol. Up to TLS 1.3 is supported.
5022
5389
  *
5023
5390
  * @example
5024
5391
  * TLS1.3
@@ -5026,7 +5393,7 @@ export declare class CreateDomainRequest extends $dara.Model {
5026
5393
  tlsMax?: string;
5027
5394
  /**
5028
5395
  * @remarks
5029
- * Minimum TLS protocol version, supports down to TLS 1.0.
5396
+ * The minimum version of the TLS protocol. Down to TLS 1.0 is supported.
5030
5397
  *
5031
5398
  * @example
5032
5399
  * TLS1.0
@@ -5046,7 +5413,7 @@ export declare class CreateDomainRequest extends $dara.Model {
5046
5413
  export declare class CreateDomainResponseBody extends $dara.Model {
5047
5414
  /**
5048
5415
  * @remarks
5049
- * Response code.
5416
+ * The status code returned.
5050
5417
  *
5051
5418
  * @example
5052
5419
  * Ok
@@ -5054,12 +5421,12 @@ export declare class CreateDomainResponseBody extends $dara.Model {
5054
5421
  code?: string;
5055
5422
  /**
5056
5423
  * @remarks
5057
- * Response data.
5424
+ * The response data.
5058
5425
  */
5059
5426
  data?: CreateDomainResponseBodyData;
5060
5427
  /**
5061
5428
  * @remarks
5062
- * Response message.
5429
+ * The response message returned.
5063
5430
  *
5064
5431
  * @example
5065
5432
  * success
@@ -5067,7 +5434,7 @@ export declare class CreateDomainResponseBody extends $dara.Model {
5067
5434
  message?: string;
5068
5435
  /**
5069
5436
  * @remarks
5070
- * Request ID, used for tracing the API call chain.
5437
+ * The request ID, which is used to trace the API call link.
5071
5438
  *
5072
5439
  * @example
5073
5440
  * 0C2D1C68-0D93-5561-8EE6-FDB7BF067A30
@@ -5220,13 +5587,19 @@ export declare class CreateEnvironmentResponse extends $dara.Model {
5220
5587
  export declare class CreateHttpApiRequest extends $dara.Model {
5221
5588
  /**
5222
5589
  * @remarks
5223
- * The AI protocols list.
5590
+ * The AI API protocols. Valid value:
5591
+ *
5592
+ * * OpenAI/v1
5224
5593
  */
5225
5594
  aiProtocols?: string[];
5595
+ /**
5596
+ * @remarks
5597
+ * The authentication configurations.
5598
+ */
5226
5599
  authConfig?: AuthConfig;
5227
5600
  /**
5228
5601
  * @remarks
5229
- * Base path of the API, which must start with a \\"/\\".
5602
+ * The API base path, which must start with a forward slash (/).
5230
5603
  *
5231
5604
  * @example
5232
5605
  * /v1
@@ -5234,26 +5607,30 @@ export declare class CreateHttpApiRequest extends $dara.Model {
5234
5607
  basePath?: string;
5235
5608
  /**
5236
5609
  * @remarks
5237
- * The deploy configs.
5610
+ * The API deployment configurations. Currently, only AI APIs support deployment configurations, and only a single deployment configuration can be passed.
5238
5611
  */
5239
5612
  deployConfigs?: HttpApiDeployConfig[];
5240
5613
  /**
5241
5614
  * @remarks
5242
- * Description of the API.
5615
+ * The API description.
5243
5616
  *
5244
5617
  * @example
5245
- * 测试专用API。
5618
+ * API for testing
5246
5619
  */
5247
5620
  description?: string;
5621
+ /**
5622
+ * @remarks
5623
+ * Specifies whether to enable authentication.
5624
+ */
5248
5625
  enableAuth?: boolean;
5249
5626
  /**
5250
5627
  * @remarks
5251
- * Configuration information for the HTTP Ingress API.
5628
+ * The HTTP Ingress configurations.
5252
5629
  */
5253
5630
  ingressConfig?: CreateHttpApiRequestIngressConfig;
5254
5631
  /**
5255
5632
  * @remarks
5256
- * Name of the API.
5633
+ * The API name.
5257
5634
  *
5258
5635
  * This parameter is required.
5259
5636
  *
@@ -5263,12 +5640,12 @@ export declare class CreateHttpApiRequest extends $dara.Model {
5263
5640
  name?: string;
5264
5641
  /**
5265
5642
  * @remarks
5266
- * List of API access protocols.
5643
+ * The protocols that are used to call the API.
5267
5644
  */
5268
5645
  protocols?: string[];
5269
5646
  /**
5270
5647
  * @remarks
5271
- * The ID of the resource group.
5648
+ * The resource group ID.
5272
5649
  *
5273
5650
  * @example
5274
5651
  * rg-aekzgvmlotionbi
@@ -5276,11 +5653,12 @@ export declare class CreateHttpApiRequest extends $dara.Model {
5276
5653
  resourceGroupId?: string;
5277
5654
  /**
5278
5655
  * @remarks
5279
- * Type of the HTTP API.
5280
- * - Http
5281
- * - Rest
5282
- * - WebSocket
5283
- * - HttpIngress
5656
+ * The API type. Valid values:
5657
+ *
5658
+ * * Http
5659
+ * * Rest
5660
+ * * WebSocket
5661
+ * * HttpIngress
5284
5662
  *
5285
5663
  * @example
5286
5664
  * Http
@@ -5288,7 +5666,7 @@ export declare class CreateHttpApiRequest extends $dara.Model {
5288
5666
  type?: string;
5289
5667
  /**
5290
5668
  * @remarks
5291
- * Versioning configuration for the API.
5669
+ * The versioning configuration of the API.
5292
5670
  */
5293
5671
  versionConfig?: HttpApiVersionConfig;
5294
5672
  static names(): {
@@ -5305,7 +5683,7 @@ export declare class CreateHttpApiRequest extends $dara.Model {
5305
5683
  export declare class CreateHttpApiResponseBody extends $dara.Model {
5306
5684
  /**
5307
5685
  * @remarks
5308
- * Status code.
5686
+ * The status code.
5309
5687
  *
5310
5688
  * @example
5311
5689
  * Ok
@@ -5313,12 +5691,12 @@ export declare class CreateHttpApiResponseBody extends $dara.Model {
5313
5691
  code?: string;
5314
5692
  /**
5315
5693
  * @remarks
5316
- * API information.
5694
+ * The API information.
5317
5695
  */
5318
5696
  data?: CreateHttpApiResponseBodyData;
5319
5697
  /**
5320
5698
  * @remarks
5321
- * Response message.
5699
+ * The returned message.
5322
5700
  *
5323
5701
  * @example
5324
5702
  * success
@@ -5326,7 +5704,7 @@ export declare class CreateHttpApiResponseBody extends $dara.Model {
5326
5704
  message?: string;
5327
5705
  /**
5328
5706
  * @remarks
5329
- * Request ID.
5707
+ * The request ID.
5330
5708
  *
5331
5709
  * @example
5332
5710
  * A1994B10-C6A8-58FA-8347-6A08B0D4EFDE
@@ -5438,25 +5816,25 @@ export declare class CreateHttpApiOperationResponse extends $dara.Model {
5438
5816
  export declare class CreateHttpApiRouteRequest extends $dara.Model {
5439
5817
  /**
5440
5818
  * @remarks
5441
- * Backend service configuration for the route.
5819
+ * The backend service configurations of the route.
5442
5820
  */
5443
5821
  backendConfig?: CreateHttpApiRouteRequestBackendConfig;
5444
5822
  /**
5445
5823
  * @remarks
5446
- * Route description.
5824
+ * The route description.
5447
5825
  *
5448
5826
  * @example
5449
- * 用户登陆路由。
5827
+ * User logon route
5450
5828
  */
5451
5829
  description?: string;
5452
5830
  /**
5453
5831
  * @remarks
5454
- * Domain IDs.
5832
+ * The domain name IDs.
5455
5833
  */
5456
5834
  domainIds?: string[];
5457
5835
  /**
5458
5836
  * @remarks
5459
- * Environment ID.
5837
+ * The environment ID.
5460
5838
  *
5461
5839
  * @example
5462
5840
  * env-cpqnr6tlhtgubcv***
@@ -5464,12 +5842,12 @@ export declare class CreateHttpApiRouteRequest extends $dara.Model {
5464
5842
  environmentId?: string;
5465
5843
  /**
5466
5844
  * @remarks
5467
- * Route match rules.
5845
+ * The rule for matching the route.
5468
5846
  */
5469
5847
  match?: HttpRouteMatch;
5470
5848
  /**
5471
5849
  * @remarks
5472
- * Route name.
5850
+ * The route name.
5473
5851
  *
5474
5852
  * @example
5475
5853
  * login
@@ -5489,7 +5867,7 @@ export declare class CreateHttpApiRouteRequest extends $dara.Model {
5489
5867
  export declare class CreateHttpApiRouteResponseBody extends $dara.Model {
5490
5868
  /**
5491
5869
  * @remarks
5492
- * Response status code.
5870
+ * The status code.
5493
5871
  *
5494
5872
  * @example
5495
5873
  * Ok
@@ -5497,12 +5875,12 @@ export declare class CreateHttpApiRouteResponseBody extends $dara.Model {
5497
5875
  code?: string;
5498
5876
  /**
5499
5877
  * @remarks
5500
- * Response data.
5878
+ * The response data.
5501
5879
  */
5502
5880
  data?: CreateHttpApiRouteResponseBodyData;
5503
5881
  /**
5504
5882
  * @remarks
5505
- * Response message.
5883
+ * The returned message.
5506
5884
  *
5507
5885
  * @example
5508
5886
  * success
@@ -5510,7 +5888,7 @@ export declare class CreateHttpApiRouteResponseBody extends $dara.Model {
5510
5888
  message?: string;
5511
5889
  /**
5512
5890
  * @remarks
5513
- * Request ID.
5891
+ * The request ID.
5514
5892
  *
5515
5893
  * @example
5516
5894
  * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
@@ -5547,6 +5925,8 @@ export declare class CreateHttpApiRouteResponse extends $dara.Model {
5547
5925
  export declare class CreatePolicyRequest extends $dara.Model {
5548
5926
  /**
5549
5927
  * @remarks
5928
+ * Policy type, including RateLimit, ConcurrencyLimit, CircuitBreaker, HttpRewrite, HeaderModify, Cors, Authentication, FlowCopy, Timeout, Retry, IpAccessControl, DirectResponse, Redirect, Fallback, ServiceTls, ServiceLb, ServicePortTls, Waf, JWTAuth, OIDCAuth, ExternalZAuth, AiProxy, ModelRouter, AiStatistics, AiSecurityGuard, AiFallback, ModelMapper, AiTokenRateLimit, AiCache, DynamicRoute
5929
+ *
5550
5930
  * This parameter is required.
5551
5931
  *
5552
5932
  * @example
@@ -5555,15 +5935,26 @@ export declare class CreatePolicyRequest extends $dara.Model {
5555
5935
  className?: string;
5556
5936
  /**
5557
5937
  * @remarks
5938
+ * Policy configuration
5939
+ *
5558
5940
  * This parameter is required.
5559
5941
  *
5560
5942
  * @example
5561
5943
  * {"unitNum":1,"timeUnit":"s","enable":true}
5562
5944
  */
5563
5945
  config?: string;
5946
+ /**
5947
+ * @remarks
5948
+ * Policy description
5949
+ *
5950
+ * @example
5951
+ * timeout policy
5952
+ */
5564
5953
  description?: string;
5565
5954
  /**
5566
5955
  * @remarks
5956
+ * Policy name
5957
+ *
5567
5958
  * This parameter is required.
5568
5959
  *
5569
5960
  * @example
@@ -5583,19 +5974,29 @@ export declare class CreatePolicyRequest extends $dara.Model {
5583
5974
  }
5584
5975
  export declare class CreatePolicyResponseBody extends $dara.Model {
5585
5976
  /**
5977
+ * @remarks
5978
+ * Response status code.
5979
+ *
5586
5980
  * @example
5587
5981
  * Ok
5588
5982
  */
5589
5983
  code?: string;
5984
+ /**
5985
+ * @remarks
5986
+ * Response data.
5987
+ */
5590
5988
  data?: CreatePolicyResponseBodyData;
5591
5989
  /**
5990
+ * @remarks
5991
+ * Response message.
5992
+ *
5592
5993
  * @example
5593
5994
  * success
5594
5995
  */
5595
5996
  message?: string;
5596
5997
  /**
5597
5998
  * @remarks
5598
- * Id of the request
5999
+ * ID of the request
5599
6000
  *
5600
6001
  * @example
5601
6002
  * 393E2630-DBE7-5221-AB35-9E7406754***
@@ -5632,6 +6033,8 @@ export declare class CreatePolicyResponse extends $dara.Model {
5632
6033
  export declare class CreatePolicyAttachmentRequest extends $dara.Model {
5633
6034
  /**
5634
6035
  * @remarks
6036
+ * Attached resource ID
6037
+ *
5635
6038
  * This parameter is required.
5636
6039
  *
5637
6040
  * @example
@@ -5640,6 +6043,8 @@ export declare class CreatePolicyAttachmentRequest extends $dara.Model {
5640
6043
  attachResourceId?: string;
5641
6044
  /**
5642
6045
  * @remarks
6046
+ * Attached resource type, such as HttpApi, GatewayRoute, Operation, GatewayService, GatewayServicePort, Gateway, Domain
6047
+ *
5643
6048
  * This parameter is required.
5644
6049
  *
5645
6050
  * @example
@@ -5648,6 +6053,8 @@ export declare class CreatePolicyAttachmentRequest extends $dara.Model {
5648
6053
  attachResourceType?: string;
5649
6054
  /**
5650
6055
  * @remarks
6056
+ * Environment ID
6057
+ *
5651
6058
  * This parameter is required.
5652
6059
  *
5653
6060
  * @example
@@ -5656,6 +6063,8 @@ export declare class CreatePolicyAttachmentRequest extends $dara.Model {
5656
6063
  environmentId?: string;
5657
6064
  /**
5658
6065
  * @remarks
6066
+ * Gateway instance ID
6067
+ *
5659
6068
  * This parameter is required.
5660
6069
  *
5661
6070
  * @example
@@ -5664,6 +6073,8 @@ export declare class CreatePolicyAttachmentRequest extends $dara.Model {
5664
6073
  gatewayId?: string;
5665
6074
  /**
5666
6075
  * @remarks
6076
+ * Policy ID
6077
+ *
5667
6078
  * This parameter is required.
5668
6079
  *
5669
6080
  * @example
@@ -5683,19 +6094,29 @@ export declare class CreatePolicyAttachmentRequest extends $dara.Model {
5683
6094
  }
5684
6095
  export declare class CreatePolicyAttachmentResponseBody extends $dara.Model {
5685
6096
  /**
6097
+ * @remarks
6098
+ * Response code.
6099
+ *
5686
6100
  * @example
5687
6101
  * Ok
5688
6102
  */
5689
6103
  code?: string;
6104
+ /**
6105
+ * @remarks
6106
+ * Response data.
6107
+ */
5690
6108
  data?: CreatePolicyAttachmentResponseBodyData;
5691
6109
  /**
6110
+ * @remarks
6111
+ * Response message.
6112
+ *
5692
6113
  * @example
5693
6114
  * success
5694
6115
  */
5695
6116
  message?: string;
5696
6117
  /**
5697
6118
  * @remarks
5698
- * Id of the request
6119
+ * ID of the request
5699
6120
  *
5700
6121
  * @example
5701
6122
  * 585657D2-1C20-5B8A-AF17-D727C64***
@@ -5731,13 +6152,46 @@ export declare class CreatePolicyAttachmentResponse extends $dara.Model {
5731
6152
  }
5732
6153
  export declare class CreateServiceRequest extends $dara.Model {
5733
6154
  /**
6155
+ * @remarks
6156
+ * The gateway instance ID.
6157
+ *
5734
6158
  * @example
5735
6159
  * gw-cq7l5s5lhtg***
5736
6160
  */
5737
6161
  gatewayId?: string;
6162
+ /**
6163
+ * @remarks
6164
+ * The resource group ID.
6165
+ *
6166
+ * @example
6167
+ * rg-xxx
6168
+ */
5738
6169
  resourceGroupId?: string;
6170
+ /**
6171
+ * @remarks
6172
+ * The list of service configurations.
6173
+ */
5739
6174
  serviceConfigs?: CreateServiceRequestServiceConfigs[];
5740
6175
  /**
6176
+ * @remarks
6177
+ * The service source. Valid values:
6178
+ *
6179
+ * * MSE_NACOS: a service in an MSE Nacos instance
6180
+ * * K8S: a service in a Kubernetes (K8s) cluster in Container Service for Kubernetes (ACK)
6181
+ * * VIP: a fixed IP address
6182
+ * * DNS: a Domain Name System (DNS) domain name
6183
+ * * FC3: a service in Function Compute
6184
+ * * SAE_K8S_SERVICE: a service in a K8s cluster in Serverless App Engine (SAE)
6185
+ *
6186
+ * Enumerated values:
6187
+ *
6188
+ * * SAE_K8S_SERVICE
6189
+ * * K8S
6190
+ * * FC3
6191
+ * * DNS
6192
+ * * VIP
6193
+ * * MSE_NACOS
6194
+ *
5741
6195
  * @example
5742
6196
  * MSE_NACOS
5743
6197
  */
@@ -5755,17 +6209,30 @@ export declare class CreateServiceRequest extends $dara.Model {
5755
6209
  }
5756
6210
  export declare class CreateServiceResponseBody extends $dara.Model {
5757
6211
  /**
6212
+ * @remarks
6213
+ * The status code.
6214
+ *
5758
6215
  * @example
5759
6216
  * Ok
5760
6217
  */
5761
6218
  code?: string;
6219
+ /**
6220
+ * @remarks
6221
+ * The response data.
6222
+ */
5762
6223
  data?: CreateServiceResponseBodyData;
5763
6224
  /**
6225
+ * @remarks
6226
+ * The returned message.
6227
+ *
5764
6228
  * @example
5765
6229
  * success
5766
6230
  */
5767
6231
  message?: string;
5768
6232
  /**
6233
+ * @remarks
6234
+ * The request ID.
6235
+ *
5769
6236
  * @example
5770
6237
  * C67DED2B-F19B-5BEC-88C1-D6EB854CD0D4
5771
6238
  */
@@ -6033,7 +6500,7 @@ export declare class DeleteGatewaySecurityGroupRuleResponse extends $dara.Model
6033
6500
  export declare class DeleteHttpApiResponseBody extends $dara.Model {
6034
6501
  /**
6035
6502
  * @remarks
6036
- * Response status code.
6503
+ * The status code.
6037
6504
  *
6038
6505
  * @example
6039
6506
  * Ok
@@ -6041,7 +6508,7 @@ export declare class DeleteHttpApiResponseBody extends $dara.Model {
6041
6508
  code?: string;
6042
6509
  /**
6043
6510
  * @remarks
6044
- * Response message.
6511
+ * The returned message.
6045
6512
  *
6046
6513
  * @example
6047
6514
  * success
@@ -6049,7 +6516,7 @@ export declare class DeleteHttpApiResponseBody extends $dara.Model {
6049
6516
  message?: string;
6050
6517
  /**
6051
6518
  * @remarks
6052
- * Request ID.
6519
+ * The request ID.
6053
6520
  *
6054
6521
  * @example
6055
6522
  * 5B626361-070A-56A7-B127-ADAC8F3655DB
@@ -6191,18 +6658,24 @@ export declare class DeleteHttpApiRouteResponse extends $dara.Model {
6191
6658
  }
6192
6659
  export declare class DeletePolicyResponseBody extends $dara.Model {
6193
6660
  /**
6661
+ * @remarks
6662
+ * Response status code.
6663
+ *
6194
6664
  * @example
6195
6665
  * Ok
6196
6666
  */
6197
6667
  code?: string;
6198
6668
  /**
6669
+ * @remarks
6670
+ * Response message.
6671
+ *
6199
6672
  * @example
6200
6673
  * success
6201
6674
  */
6202
6675
  message?: string;
6203
6676
  /**
6204
6677
  * @remarks
6205
- * Id of the request
6678
+ * ID of the request
6206
6679
  *
6207
6680
  * @example
6208
6681
  * 393E2630-DBE7-5221-AB35-9E7406754***
@@ -6238,18 +6711,24 @@ export declare class DeletePolicyResponse extends $dara.Model {
6238
6711
  }
6239
6712
  export declare class DeletePolicyAttachmentResponseBody extends $dara.Model {
6240
6713
  /**
6714
+ * @remarks
6715
+ * Response status code.
6716
+ *
6241
6717
  * @example
6242
6718
  * 200
6243
6719
  */
6244
6720
  code?: string;
6245
6721
  /**
6722
+ * @remarks
6723
+ * Response message.
6724
+ *
6246
6725
  * @example
6247
6726
  * success
6248
6727
  */
6249
6728
  message?: string;
6250
6729
  /**
6251
6730
  * @remarks
6252
- * Id of the request
6731
+ * ID of the request
6253
6732
  *
6254
6733
  * @example
6255
6734
  * CE857A85-251D-5018-8103-A38957D71***
@@ -6284,8 +6763,15 @@ export declare class DeletePolicyAttachmentResponse extends $dara.Model {
6284
6763
  });
6285
6764
  }
6286
6765
  export declare class DeployHttpApiRequest extends $dara.Model {
6766
+ /**
6767
+ * @remarks
6768
+ * Rest API deployment configuration. Required when deploying an HTTP API as a Rest API.
6769
+ */
6287
6770
  restApiConfig?: DeployHttpApiRequestRestApiConfig;
6288
6771
  /**
6772
+ * @remarks
6773
+ * Route ID. This must be provided when publishing the route of an HTTP API.
6774
+ *
6289
6775
  * @example
6290
6776
  * hr-cr82undlhtgrl***
6291
6777
  */
@@ -6303,16 +6789,25 @@ export declare class DeployHttpApiRequest extends $dara.Model {
6303
6789
  }
6304
6790
  export declare class DeployHttpApiResponseBody extends $dara.Model {
6305
6791
  /**
6792
+ * @remarks
6793
+ * Response status code.
6794
+ *
6306
6795
  * @example
6307
6796
  * Ok
6308
6797
  */
6309
6798
  code?: string;
6310
6799
  /**
6800
+ * @remarks
6801
+ * 响应消息。
6802
+ *
6311
6803
  * @example
6312
6804
  * success
6313
6805
  */
6314
6806
  message?: string;
6315
6807
  /**
6808
+ * @remarks
6809
+ * Request ID.
6810
+ *
6316
6811
  * @example
6317
6812
  * 0C2D1C68-0D93-5561-8EE6-FDB7BF067A30
6318
6813
  */
@@ -6405,27 +6900,57 @@ export declare class ExportHttpApiResponse extends $dara.Model {
6405
6900
  }
6406
6901
  export declare class GetDashboardRequest extends $dara.Model {
6407
6902
  /**
6903
+ * @remarks
6904
+ * The language. Valid values: zh (Chinese) and en (English).
6905
+ *
6408
6906
  * @example
6409
6907
  * zh
6410
6908
  */
6411
6909
  acceptLanguage?: string;
6910
+ /**
6911
+ * @remarks
6912
+ * API ID
6913
+ *
6914
+ * @example
6915
+ * api-c9uuekzmia8q2****
6916
+ */
6412
6917
  apiId?: string;
6918
+ /**
6919
+ * @remarks
6920
+ * The filter configurations.
6921
+ */
6413
6922
  filter?: GetDashboardRequestFilter;
6414
6923
  /**
6924
+ * @remarks
6925
+ * The dashboard name.
6926
+ *
6927
+ * * LOG: access logs
6928
+ * * PLUGIN: plug-in logs
6929
+ *
6415
6930
  * @example
6416
6931
  * PLUGIN
6417
6932
  */
6418
6933
  name?: string;
6419
6934
  /**
6935
+ * @remarks
6936
+ * The plug-in ID.
6937
+ *
6420
6938
  * @example
6421
6939
  * pls-dn82a9djd8z****
6422
6940
  */
6423
6941
  pluginClassId?: string;
6942
+ pluginId?: string;
6424
6943
  /**
6944
+ * @remarks
6945
+ * The dashboard source. Valid values:
6946
+ *
6947
+ * * SLS: Simple Log Service
6948
+ *
6425
6949
  * @example
6426
6950
  * SLS
6427
6951
  */
6428
6952
  source?: string;
6953
+ upstreamCluster?: string;
6429
6954
  static names(): {
6430
6955
  [key: string]: string;
6431
6956
  };
@@ -6439,27 +6964,57 @@ export declare class GetDashboardRequest extends $dara.Model {
6439
6964
  }
6440
6965
  export declare class GetDashboardShrinkRequest extends $dara.Model {
6441
6966
  /**
6967
+ * @remarks
6968
+ * The language. Valid values: zh (Chinese) and en (English).
6969
+ *
6442
6970
  * @example
6443
6971
  * zh
6444
6972
  */
6445
6973
  acceptLanguage?: string;
6974
+ /**
6975
+ * @remarks
6976
+ * API ID
6977
+ *
6978
+ * @example
6979
+ * api-c9uuekzmia8q2****
6980
+ */
6446
6981
  apiId?: string;
6982
+ /**
6983
+ * @remarks
6984
+ * The filter configurations.
6985
+ */
6447
6986
  filterShrink?: string;
6448
6987
  /**
6988
+ * @remarks
6989
+ * The dashboard name.
6990
+ *
6991
+ * * LOG: access logs
6992
+ * * PLUGIN: plug-in logs
6993
+ *
6449
6994
  * @example
6450
6995
  * PLUGIN
6451
6996
  */
6452
6997
  name?: string;
6453
6998
  /**
6999
+ * @remarks
7000
+ * The plug-in ID.
7001
+ *
6454
7002
  * @example
6455
7003
  * pls-dn82a9djd8z****
6456
7004
  */
6457
7005
  pluginClassId?: string;
7006
+ pluginId?: string;
6458
7007
  /**
7008
+ * @remarks
7009
+ * The dashboard source. Valid values:
7010
+ *
7011
+ * * SLS: Simple Log Service
7012
+ *
6459
7013
  * @example
6460
7014
  * SLS
6461
7015
  */
6462
7016
  source?: string;
7017
+ upstreamCluster?: string;
6463
7018
  static names(): {
6464
7019
  [key: string]: string;
6465
7020
  };
@@ -6473,30 +7028,46 @@ export declare class GetDashboardShrinkRequest extends $dara.Model {
6473
7028
  }
6474
7029
  export declare class GetDashboardResponseBody extends $dara.Model {
6475
7030
  /**
7031
+ * @remarks
7032
+ * The HTTP status code.
7033
+ *
6476
7034
  * @example
6477
7035
  * 200
6478
7036
  */
6479
7037
  code?: number;
7038
+ /**
7039
+ * @remarks
7040
+ * The data returned.
7041
+ */
6480
7042
  data?: GetDashboardResponseBodyData;
6481
7043
  /**
7044
+ * @remarks
7045
+ * The error code.
7046
+ *
6482
7047
  * @example
6483
7048
  * Ok
6484
7049
  */
6485
7050
  errorCode?: string;
6486
7051
  /**
7052
+ * @remarks
7053
+ * The error message.
7054
+ *
6487
7055
  * @example
6488
7056
  * success
6489
7057
  */
6490
7058
  message?: string;
6491
7059
  /**
6492
7060
  * @remarks
6493
- * Id of the request
7061
+ * The request ID.
6494
7062
  *
6495
7063
  * @example
6496
7064
  * 2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
6497
7065
  */
6498
7066
  requestId?: string;
6499
7067
  /**
7068
+ * @remarks
7069
+ * Indicates whether the request was successful.
7070
+ *
6500
7071
  * @example
6501
7072
  * true
6502
7073
  */
@@ -6530,6 +7101,13 @@ export declare class GetDashboardResponse extends $dara.Model {
6530
7101
  });
6531
7102
  }
6532
7103
  export declare class GetDomainRequest extends $dara.Model {
7104
+ /**
7105
+ * @remarks
7106
+ * Specifies whether to return online resource information.
7107
+ *
7108
+ * @example
7109
+ * true
7110
+ */
6533
7111
  withStatistics?: boolean;
6534
7112
  static names(): {
6535
7113
  [key: string]: string;
@@ -6545,7 +7123,7 @@ export declare class GetDomainRequest extends $dara.Model {
6545
7123
  export declare class GetDomainResponseBody extends $dara.Model {
6546
7124
  /**
6547
7125
  * @remarks
6548
- * Response code.
7126
+ * The status code returned.
6549
7127
  *
6550
7128
  * @example
6551
7129
  * Ok
@@ -6553,12 +7131,12 @@ export declare class GetDomainResponseBody extends $dara.Model {
6553
7131
  code?: string;
6554
7132
  /**
6555
7133
  * @remarks
6556
- * Response data.
7134
+ * The data returned.
6557
7135
  */
6558
7136
  data?: GetDomainResponseBodyData;
6559
7137
  /**
6560
7138
  * @remarks
6561
- * Response message.
7139
+ * The response message returned.
6562
7140
  *
6563
7141
  * @example
6564
7142
  * success
@@ -6566,7 +7144,7 @@ export declare class GetDomainResponseBody extends $dara.Model {
6566
7144
  message?: string;
6567
7145
  /**
6568
7146
  * @remarks
6569
- * Request ID, used for tracing the API call chain.
7147
+ * The request ID, which is used to trace the API call link.
6570
7148
  *
6571
7149
  * @example
6572
7150
  * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
@@ -6863,7 +7441,7 @@ export declare class GetHttpApiOperationResponse extends $dara.Model {
6863
7441
  export declare class GetHttpApiRouteResponseBody extends $dara.Model {
6864
7442
  /**
6865
7443
  * @remarks
6866
- * Response status code.
7444
+ * The status code.
6867
7445
  *
6868
7446
  * @example
6869
7447
  * Ok
@@ -6871,12 +7449,12 @@ export declare class GetHttpApiRouteResponseBody extends $dara.Model {
6871
7449
  code?: string;
6872
7450
  /**
6873
7451
  * @remarks
6874
- * Route detail data.
7452
+ * The route details.
6875
7453
  */
6876
7454
  data?: HttpRoute;
6877
7455
  /**
6878
7456
  * @remarks
6879
- * Response message.
7457
+ * The returned message.
6880
7458
  *
6881
7459
  * @example
6882
7460
  * success
@@ -6884,7 +7462,7 @@ export declare class GetHttpApiRouteResponseBody extends $dara.Model {
6884
7462
  message?: string;
6885
7463
  /**
6886
7464
  * @remarks
6887
- * Request ID.
7465
+ * The request ID.
6888
7466
  *
6889
7467
  * @example
6890
7468
  * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
@@ -6920,19 +7498,29 @@ export declare class GetHttpApiRouteResponse extends $dara.Model {
6920
7498
  }
6921
7499
  export declare class GetPolicyResponseBody extends $dara.Model {
6922
7500
  /**
7501
+ * @remarks
7502
+ * The status code.
7503
+ *
6923
7504
  * @example
6924
7505
  * Ok
6925
7506
  */
6926
7507
  code?: string;
7508
+ /**
7509
+ * @remarks
7510
+ * The data returned.
7511
+ */
6927
7512
  data?: PolicyDetailInfo;
6928
7513
  /**
7514
+ * @remarks
7515
+ * The returned message.
7516
+ *
6929
7517
  * @example
6930
7518
  * success
6931
7519
  */
6932
7520
  message?: string;
6933
7521
  /**
6934
7522
  * @remarks
6935
- * Id of the request
7523
+ * The request ID.
6936
7524
  *
6937
7525
  * @example
6938
7526
  * 2F46B9E7-67EF-5C8A-BA52-D38D5B32A***
@@ -6968,19 +7556,29 @@ export declare class GetPolicyResponse extends $dara.Model {
6968
7556
  }
6969
7557
  export declare class GetPolicyAttachmentResponseBody extends $dara.Model {
6970
7558
  /**
7559
+ * @remarks
7560
+ * Response code.
7561
+ *
6971
7562
  * @example
6972
7563
  * 200
6973
7564
  */
6974
7565
  code?: string;
7566
+ /**
7567
+ * @remarks
7568
+ * Response data.
7569
+ */
6975
7570
  data?: GetPolicyAttachmentResponseBodyData;
6976
7571
  /**
7572
+ * @remarks
7573
+ * Response message.
7574
+ *
6977
7575
  * @example
6978
7576
  * success
6979
7577
  */
6980
7578
  message?: string;
6981
7579
  /**
6982
7580
  * @remarks
6983
- * Id of the request
7581
+ * ID of the request
6984
7582
  *
6985
7583
  * @example
6986
7584
  * 2C3B9A12-3868-5EB9-fBEA-F99E03DD1***
@@ -7016,19 +7614,32 @@ export declare class GetPolicyAttachmentResponse extends $dara.Model {
7016
7614
  }
7017
7615
  export declare class GetResourceOverviewResponseBody extends $dara.Model {
7018
7616
  /**
7617
+ * @remarks
7618
+ * Response status code.
7619
+ *
7019
7620
  * @example
7020
7621
  * Ok
7021
7622
  */
7022
7623
  code?: string;
7624
+ /**
7625
+ * @remarks
7626
+ * Resource information.
7627
+ */
7023
7628
  data?: GetResourceOverviewResponseBodyData;
7024
7629
  /**
7630
+ * @remarks
7631
+ * Response message.
7632
+ *
7025
7633
  * @example
7026
7634
  * success
7027
7635
  */
7028
7636
  message?: string;
7029
7637
  /**
7030
- * @example
7031
- * DD19A442-93C5-5C97-AFA0-B9C57EBD781B
7638
+ * @remarks
7639
+ * Request ID.
7640
+ *
7641
+ * @example
7642
+ * DD19A442-93C5-5C97-AFA0-B9C57EBD781B
7032
7643
  */
7033
7644
  requestId?: string;
7034
7645
  static names(): {
@@ -7061,17 +7672,30 @@ export declare class GetResourceOverviewResponse extends $dara.Model {
7061
7672
  }
7062
7673
  export declare class GetServiceResponseBody extends $dara.Model {
7063
7674
  /**
7675
+ * @remarks
7676
+ * The status code.
7677
+ *
7064
7678
  * @example
7065
7679
  * Ok
7066
7680
  */
7067
7681
  code?: string;
7682
+ /**
7683
+ * @remarks
7684
+ * The service details.
7685
+ */
7068
7686
  data?: Service;
7069
7687
  /**
7688
+ * @remarks
7689
+ * The returned message.
7690
+ *
7070
7691
  * @example
7071
7692
  * success
7072
7693
  */
7073
7694
  message?: string;
7074
7695
  /**
7696
+ * @remarks
7697
+ * The request ID.
7698
+ *
7075
7699
  * @example
7076
7700
  * 8FA9BB94-915B-5299-A694-49FCC7F5DD00
7077
7701
  */
@@ -7106,6 +7730,11 @@ export declare class GetServiceResponse extends $dara.Model {
7106
7730
  }
7107
7731
  export declare class GetTraceConfigRequest extends $dara.Model {
7108
7732
  /**
7733
+ * @remarks
7734
+ * Language Type:
7735
+ * zh: Chinese
7736
+ * en: English
7737
+ *
7109
7738
  * @example
7110
7739
  * zh
7111
7740
  */
@@ -7123,22 +7752,40 @@ export declare class GetTraceConfigRequest extends $dara.Model {
7123
7752
  }
7124
7753
  export declare class GetTraceConfigResponseBody extends $dara.Model {
7125
7754
  /**
7755
+ * @remarks
7756
+ * Response Code
7757
+ *
7126
7758
  * @example
7127
7759
  * 200
7128
7760
  */
7129
7761
  code?: number;
7762
+ /**
7763
+ * @remarks
7764
+ * Response Data
7765
+ */
7130
7766
  data?: GetTraceConfigResponseBodyData;
7131
7767
  /**
7768
+ * @remarks
7769
+ * Error Message
7770
+ *
7132
7771
  * @example
7133
7772
  * success
7134
7773
  */
7135
7774
  message?: string;
7136
7775
  /**
7776
+ * @remarks
7777
+ * Request ID
7778
+ *
7137
7779
  * @example
7138
7780
  * 2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
7139
7781
  */
7140
7782
  requestId?: string;
7141
7783
  /**
7784
+ * @remarks
7785
+ * Boolean Request Result, with the following values:
7786
+ * true: Request succeeded.
7787
+ * false: Request failed.
7788
+ *
7142
7789
  * @example
7143
7790
  * true
7144
7791
  */
@@ -7174,15 +7821,15 @@ export declare class GetTraceConfigResponse extends $dara.Model {
7174
7821
  export declare class ImportHttpApiRequest extends $dara.Model {
7175
7822
  /**
7176
7823
  * @remarks
7177
- * The description of the imported API. If not provided, it will be extracted from the API definition. The length is limited to 255 bytes.
7824
+ * 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.
7178
7825
  *
7179
7826
  * @example
7180
- * 测试专用API
7827
+ * API for testing
7181
7828
  */
7182
7829
  description?: string;
7183
7830
  /**
7184
7831
  * @remarks
7185
- * Pre-import check. If enabled, only the check will be performed without importing the API.
7832
+ * Specifies whether to perform a dry run. If this parameter is set to true, a dry run is performed without importing the file.
7186
7833
  *
7187
7834
  * @example
7188
7835
  * false
@@ -7190,7 +7837,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7190
7837
  dryRun?: boolean;
7191
7838
  /**
7192
7839
  * @remarks
7193
- * 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.
7840
+ * 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.
7194
7841
  *
7195
7842
  * @example
7196
7843
  * import-test
@@ -7198,7 +7845,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7198
7845
  name?: string;
7199
7846
  /**
7200
7847
  * @remarks
7201
- * The ID of the resource group.
7848
+ * [The resource group ID](https://help.aliyun.com/document_detail/151181.html).
7202
7849
  *
7203
7850
  * @example
7204
7851
  * rg-acfm3q4zjh7fkki
@@ -7206,7 +7853,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7206
7853
  resourceGroupId?: string;
7207
7854
  /**
7208
7855
  * @remarks
7209
- * 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.
7856
+ * 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.
7210
7857
  *
7211
7858
  * @example
7212
7859
  * b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo=
@@ -7214,7 +7861,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7214
7861
  specContentBase64?: string;
7215
7862
  /**
7216
7863
  * @remarks
7217
- * 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.
7864
+ * 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.
7218
7865
  *
7219
7866
  * @example
7220
7867
  * https://my-bucket.oss-cn-hangzhou.aliyuncs.com/my-api/api.yaml
@@ -7222,16 +7869,16 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7222
7869
  specFileUrl?: string;
7223
7870
  /**
7224
7871
  * @remarks
7225
- * The oss config info.
7872
+ * The OSS information.
7226
7873
  */
7227
7874
  specOssConfig?: ImportHttpApiRequestSpecOssConfig;
7228
7875
  /**
7229
7876
  * @remarks
7230
- * When the imported API name and version management match an existing API, you need to specify an update strategy.
7231
- * - SpecOnly: Completely based on the imported file.
7232
- * - SpecFirst: Prioritize the imported file, add new interfaces and update existing ones, while keeping interfaces not mentioned in the file unchanged.
7233
- * - ExistFirst: Prioritize the existing API, only add new interfaces without updating existing ones.
7234
- * If not specified, the default strategy is ExistFirst.
7877
+ * The update policy when the API to be imported has the same version and name as an existing one. Valid values:
7878
+ *
7879
+ * * SpectOnly: All configurations in the file take effect.
7880
+ * * SpecFirst: The file takes precedence. New APIs are created and existing ones are updated. APIs not included in the file remain unchanged.
7881
+ * * ExistFirst (default): The existing APIs take precedence. New APIs are created but existing ones remain unchanged.
7235
7882
  *
7236
7883
  * @example
7237
7884
  * ExistFirst
@@ -7239,7 +7886,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7239
7886
  strategy?: string;
7240
7887
  /**
7241
7888
  * @remarks
7242
- * 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.
7889
+ * 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.
7243
7890
  *
7244
7891
  * @example
7245
7892
  * api-xxxx
@@ -7247,7 +7894,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7247
7894
  targetHttpApiId?: string;
7248
7895
  /**
7249
7896
  * @remarks
7250
- * 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.
7897
+ * Version configuration.
7251
7898
  */
7252
7899
  versionConfig?: HttpApiVersionConfig;
7253
7900
  static names(): {
@@ -7264,7 +7911,7 @@ export declare class ImportHttpApiRequest extends $dara.Model {
7264
7911
  export declare class ImportHttpApiResponseBody extends $dara.Model {
7265
7912
  /**
7266
7913
  * @remarks
7267
- * Response status code.
7914
+ * The status code.
7268
7915
  *
7269
7916
  * @example
7270
7917
  * Ok
@@ -7272,12 +7919,12 @@ export declare class ImportHttpApiResponseBody extends $dara.Model {
7272
7919
  code?: string;
7273
7920
  /**
7274
7921
  * @remarks
7275
- * API information.
7922
+ * The API information.
7276
7923
  */
7277
7924
  data?: ImportHttpApiResponseBodyData;
7278
7925
  /**
7279
7926
  * @remarks
7280
- * Response message.
7927
+ * The returned message.
7281
7928
  *
7282
7929
  * @example
7283
7930
  * success
@@ -7285,7 +7932,7 @@ export declare class ImportHttpApiResponseBody extends $dara.Model {
7285
7932
  message?: string;
7286
7933
  /**
7287
7934
  * @remarks
7288
- * Request ID.
7935
+ * The request ID.
7289
7936
  *
7290
7937
  * @example
7291
7938
  * CE857A85-251D-5018-8103-A38957D71E20
@@ -7322,7 +7969,7 @@ export declare class ImportHttpApiResponse extends $dara.Model {
7322
7969
  export declare class ListDomainsRequest extends $dara.Model {
7323
7970
  /**
7324
7971
  * @remarks
7325
- * Gateway Id.
7972
+ * The instance ID.
7326
7973
  *
7327
7974
  * @example
7328
7975
  * gw-xxx
@@ -7330,7 +7977,7 @@ export declare class ListDomainsRequest extends $dara.Model {
7330
7977
  gatewayId?: string;
7331
7978
  /**
7332
7979
  * @remarks
7333
- * Domain name, fuzzy search.
7980
+ * The domain name keyword for fuzzy search.
7334
7981
  *
7335
7982
  * @example
7336
7983
  * test
@@ -7338,7 +7985,7 @@ export declare class ListDomainsRequest extends $dara.Model {
7338
7985
  nameLike?: string;
7339
7986
  /**
7340
7987
  * @remarks
7341
- * Page number, default is 1.
7988
+ * The page number of the page to return. Default value: 1.
7342
7989
  *
7343
7990
  * @example
7344
7991
  * 1
@@ -7346,7 +7993,7 @@ export declare class ListDomainsRequest extends $dara.Model {
7346
7993
  pageNumber?: number;
7347
7994
  /**
7348
7995
  * @remarks
7349
- * Number of items per page, default is 10.
7996
+ * The number of entries per page. Default value: 10.
7350
7997
  *
7351
7998
  * @example
7352
7999
  * 10
@@ -7354,7 +8001,7 @@ export declare class ListDomainsRequest extends $dara.Model {
7354
8001
  pageSize?: number;
7355
8002
  /**
7356
8003
  * @remarks
7357
- * Resource group ID.
8004
+ * The ID of the resource group.
7358
8005
  *
7359
8006
  * @example
7360
8007
  * rg-ahr5uil8raz0rq3b
@@ -7374,7 +8021,7 @@ export declare class ListDomainsRequest extends $dara.Model {
7374
8021
  export declare class ListDomainsResponseBody extends $dara.Model {
7375
8022
  /**
7376
8023
  * @remarks
7377
- * Response code.
8024
+ * The status code returned.
7378
8025
  *
7379
8026
  * @example
7380
8027
  * Ok
@@ -7382,12 +8029,12 @@ export declare class ListDomainsResponseBody extends $dara.Model {
7382
8029
  code?: string;
7383
8030
  /**
7384
8031
  * @remarks
7385
- * Response data.
8032
+ * The response data.
7386
8033
  */
7387
8034
  data?: ListDomainsResponseBodyData;
7388
8035
  /**
7389
8036
  * @remarks
7390
- * Response message.
8037
+ * The message returned.
7391
8038
  *
7392
8039
  * @example
7393
8040
  * success
@@ -7395,7 +8042,7 @@ export declare class ListDomainsResponseBody extends $dara.Model {
7395
8042
  message?: string;
7396
8043
  /**
7397
8044
  * @remarks
7398
- * Request ID, used for tracing the API call chain.
8045
+ * The request ID, which is used to trace the API call link.
7399
8046
  *
7400
8047
  * @example
7401
8048
  * C61E30D3-579A-5B43-994E-31E02EDC9129
@@ -7558,7 +8205,7 @@ export declare class ListEnvironmentsResponse extends $dara.Model {
7558
8205
  export declare class ListGatewaysRequest extends $dara.Model {
7559
8206
  /**
7560
8207
  * @remarks
7561
- * Query exactly by Gateway ID.
8208
+ * The instance ID. If you specify an ID, an exact search is performed.
7562
8209
  *
7563
8210
  * @example
7564
8211
  * gw-cpv4sqdl****
@@ -7566,7 +8213,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7566
8213
  gatewayId?: string;
7567
8214
  /**
7568
8215
  * @remarks
7569
- * Keyword, search with full match, case-insensitive.
8216
+ * The search keyword. A full match is performed. The search is case-insensitive.
7570
8217
  *
7571
8218
  * @example
7572
8219
  * dev
@@ -7574,7 +8221,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7574
8221
  keyword?: string;
7575
8222
  /**
7576
8223
  * @remarks
7577
- * Query exactly by Gateway name.
8224
+ * The instance name. If you specify a name, an exact search is performed.
7578
8225
  *
7579
8226
  * @example
7580
8227
  * itemcenter-gateway
@@ -7582,7 +8229,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7582
8229
  name?: string;
7583
8230
  /**
7584
8231
  * @remarks
7585
- * Page number.
8232
+ * The number of the page to return.
7586
8233
  *
7587
8234
  * @example
7588
8235
  * 1
@@ -7590,7 +8237,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7590
8237
  pageNumber?: number;
7591
8238
  /**
7592
8239
  * @remarks
7593
- * Page size.
8240
+ * The number of entries per page.
7594
8241
  *
7595
8242
  * @example
7596
8243
  * 10
@@ -7598,7 +8245,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7598
8245
  pageSize?: number;
7599
8246
  /**
7600
8247
  * @remarks
7601
- * Resource group ID.
8248
+ * The resource group ID.
7602
8249
  *
7603
8250
  * @example
7604
8251
  * rg-aekz3wes3hnre5a
@@ -7606,7 +8253,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7606
8253
  resourceGroupId?: string;
7607
8254
  /**
7608
8255
  * @remarks
7609
- * Filter list by tags
8256
+ * The tags that you want to use for the search.
7610
8257
  */
7611
8258
  tag?: ListGatewaysRequestTag[];
7612
8259
  static names(): {
@@ -7623,7 +8270,7 @@ export declare class ListGatewaysRequest extends $dara.Model {
7623
8270
  export declare class ListGatewaysShrinkRequest extends $dara.Model {
7624
8271
  /**
7625
8272
  * @remarks
7626
- * Query exactly by Gateway ID.
8273
+ * The instance ID. If you specify an ID, an exact search is performed.
7627
8274
  *
7628
8275
  * @example
7629
8276
  * gw-cpv4sqdl****
@@ -7631,7 +8278,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7631
8278
  gatewayId?: string;
7632
8279
  /**
7633
8280
  * @remarks
7634
- * Keyword, search with full match, case-insensitive.
8281
+ * The search keyword. A full match is performed. The search is case-insensitive.
7635
8282
  *
7636
8283
  * @example
7637
8284
  * dev
@@ -7639,7 +8286,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7639
8286
  keyword?: string;
7640
8287
  /**
7641
8288
  * @remarks
7642
- * Query exactly by Gateway name.
8289
+ * The instance name. If you specify a name, an exact search is performed.
7643
8290
  *
7644
8291
  * @example
7645
8292
  * itemcenter-gateway
@@ -7647,7 +8294,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7647
8294
  name?: string;
7648
8295
  /**
7649
8296
  * @remarks
7650
- * Page number.
8297
+ * The number of the page to return.
7651
8298
  *
7652
8299
  * @example
7653
8300
  * 1
@@ -7655,7 +8302,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7655
8302
  pageNumber?: number;
7656
8303
  /**
7657
8304
  * @remarks
7658
- * Page size.
8305
+ * The number of entries per page.
7659
8306
  *
7660
8307
  * @example
7661
8308
  * 10
@@ -7663,7 +8310,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7663
8310
  pageSize?: number;
7664
8311
  /**
7665
8312
  * @remarks
7666
- * Resource group ID.
8313
+ * The resource group ID.
7667
8314
  *
7668
8315
  * @example
7669
8316
  * rg-aekz3wes3hnre5a
@@ -7671,7 +8318,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7671
8318
  resourceGroupId?: string;
7672
8319
  /**
7673
8320
  * @remarks
7674
- * Filter list by tags
8321
+ * The tags that you want to use for the search.
7675
8322
  */
7676
8323
  tagShrink?: string;
7677
8324
  static names(): {
@@ -7688,7 +8335,7 @@ export declare class ListGatewaysShrinkRequest extends $dara.Model {
7688
8335
  export declare class ListGatewaysResponseBody extends $dara.Model {
7689
8336
  /**
7690
8337
  * @remarks
7691
- * Response status code.
8338
+ * The status code.
7692
8339
  *
7693
8340
  * @example
7694
8341
  * Ok
@@ -7696,12 +8343,12 @@ export declare class ListGatewaysResponseBody extends $dara.Model {
7696
8343
  code?: string;
7697
8344
  /**
7698
8345
  * @remarks
7699
- * Result of gateway list query.
8346
+ * The instances.
7700
8347
  */
7701
8348
  data?: ListGatewaysResponseBodyData;
7702
8349
  /**
7703
8350
  * @remarks
7704
- * Response message.
8351
+ * The returned message.
7705
8352
  *
7706
8353
  * @example
7707
8354
  * success
@@ -7709,7 +8356,7 @@ export declare class ListGatewaysResponseBody extends $dara.Model {
7709
8356
  message?: string;
7710
8357
  /**
7711
8358
  * @remarks
7712
- * Request ID.
8359
+ * The request ID.
7713
8360
  *
7714
8361
  * @example
7715
8362
  * 5B626361-070A-56A7-B127-ADAC8F3655DB
@@ -7894,50 +8541,119 @@ export declare class ListHttpApiOperationsResponse extends $dara.Model {
7894
8541
  });
7895
8542
  }
7896
8543
  export declare class ListHttpApiRoutesRequest extends $dara.Model {
8544
+ /**
8545
+ * @remarks
8546
+ * The string that is used to filter routes based on consumer authentication rules. Only authorized APIs are returned.
8547
+ *
8548
+ * @example
8549
+ * cas-xxx
8550
+ */
7897
8551
  consumerAuthorizationRuleId?: string;
7898
8552
  /**
8553
+ * @remarks
8554
+ * The deployment state of the route.
8555
+ *
8556
+ * Enumerated values:
8557
+ *
8558
+ * * Deploying: The route is being deployed.
8559
+ * * DeployedWithChanges: The route is deployed and modified.
8560
+ * * Undeploying: The route is being undeployed.
8561
+ * * NotDeployed: The route is not deployed.
8562
+ * * Deployed: The route is deployed.
8563
+ * * UndeployFailed: The route failed to be undeployed.
8564
+ * * DeployFailed: The route failed to be deployed.
8565
+ *
7899
8566
  * @example
7900
8567
  * NotDeployed
7901
8568
  */
7902
8569
  deployStatuses?: string;
8570
+ /**
8571
+ * @remarks
8572
+ * Specifies to filter routes by domain ID.
8573
+ *
8574
+ * @example
8575
+ * d-xxx
8576
+ */
7903
8577
  domainId?: string;
7904
8578
  /**
8579
+ * @remarks
8580
+ * The environment ID.
8581
+ *
7905
8582
  * @example
7906
8583
  * env-cpqnr6tlhtgubc***
7907
8584
  */
7908
8585
  environmentId?: string;
7909
8586
  /**
8587
+ * @remarks
8588
+ * The ID of the Cloud-native API Gateway instance.
8589
+ *
7910
8590
  * @example
7911
8591
  * gw-cpv4sqdl****
7912
8592
  */
7913
8593
  gatewayId?: string;
7914
8594
  /**
8595
+ * @remarks
8596
+ * The route name.
8597
+ *
7915
8598
  * @example
7916
8599
  * itemcenter-gateway
7917
8600
  */
7918
8601
  name?: string;
7919
8602
  /**
8603
+ * @remarks
8604
+ * The route name keyword for a fuzzy search.
8605
+ *
7920
8606
  * @example
7921
8607
  * item
7922
8608
  */
7923
8609
  nameLike?: string;
7924
8610
  /**
8611
+ * @remarks
8612
+ * The page number of the page to return. Pages start from page 1. Default value: 1.
8613
+ *
7925
8614
  * @example
7926
8615
  * 1
7927
8616
  */
7928
8617
  pageNumber?: number;
7929
8618
  /**
8619
+ * @remarks
8620
+ * The number of entries per page. Valid values: 1 to 100. Default value: 10.
8621
+ *
7930
8622
  * @example
7931
8623
  * 10
7932
8624
  */
7933
8625
  pageSize?: number;
7934
8626
  /**
8627
+ * @remarks
8628
+ * The route path keyword for a fuzzy search.
8629
+ *
7935
8630
  * @example
7936
8631
  * /v1
7937
8632
  */
7938
8633
  pathLike?: string;
8634
+ /**
8635
+ * @remarks
8636
+ * The consumer authorization information in the response.
8637
+ *
8638
+ * @example
8639
+ * true
8640
+ */
7939
8641
  withAuthPolicyInfo?: boolean;
8642
+ /**
8643
+ * @remarks
8644
+ * The authentication rules of the specified consumer in each route returned.
8645
+ *
8646
+ * @example
8647
+ * cs-xxx
8648
+ */
7940
8649
  withConsumerInfoById?: string;
8650
+ /**
8651
+ * @remarks
8652
+ * The mounting information of the specified plug-in in each route returned.
8653
+ *
8654
+ * @example
8655
+ * pl-xxx
8656
+ */
7941
8657
  withPluginAttachmentByPluginId?: string;
7942
8658
  static names(): {
7943
8659
  [key: string]: string;
@@ -7952,17 +8668,30 @@ export declare class ListHttpApiRoutesRequest extends $dara.Model {
7952
8668
  }
7953
8669
  export declare class ListHttpApiRoutesResponseBody extends $dara.Model {
7954
8670
  /**
8671
+ * @remarks
8672
+ * The status code.
8673
+ *
7955
8674
  * @example
7956
8675
  * Ok
7957
8676
  */
7958
8677
  code?: string;
8678
+ /**
8679
+ * @remarks
8680
+ * The response parameters.
8681
+ */
7959
8682
  data?: ListHttpApiRoutesResponseBodyData;
7960
8683
  /**
8684
+ * @remarks
8685
+ * The returned message.
8686
+ *
7961
8687
  * @example
7962
8688
  * success
7963
8689
  */
7964
8690
  message?: string;
7965
8691
  /**
8692
+ * @remarks
8693
+ * The request ID.
8694
+ *
7966
8695
  * @example
7967
8696
  * CBEEB8C1-108E-50F0-9BEA-DED79553C309
7968
8697
  */
@@ -7998,7 +8727,7 @@ export declare class ListHttpApiRoutesResponse extends $dara.Model {
7998
8727
  export declare class ListHttpApisRequest extends $dara.Model {
7999
8728
  /**
8000
8729
  * @remarks
8001
- * Cloud-native API Gateway ID.
8730
+ * The ID of the Cloud-native API Gateway instance.
8002
8731
  *
8003
8732
  * @example
8004
8733
  * gw-cq2avtllh****
@@ -8006,7 +8735,7 @@ export declare class ListHttpApisRequest extends $dara.Model {
8006
8735
  gatewayId?: string;
8007
8736
  /**
8008
8737
  * @remarks
8009
- * Search keyword, supports fuzzy search by API name or exact search by API ID.
8738
+ * The search keyword. You can fuzzy-search by API name or exact-search by API ID.
8010
8739
  *
8011
8740
  * @example
8012
8741
  * test-
@@ -8014,7 +8743,7 @@ export declare class ListHttpApisRequest extends $dara.Model {
8014
8743
  keyword?: string;
8015
8744
  /**
8016
8745
  * @remarks
8017
- * Exact search by name.
8746
+ * The API name that is used for the search. In this case, exact search is performed.
8018
8747
  *
8019
8748
  * @example
8020
8749
  * login
@@ -8022,7 +8751,7 @@ export declare class ListHttpApisRequest extends $dara.Model {
8022
8751
  name?: string;
8023
8752
  /**
8024
8753
  * @remarks
8025
- * Page number, starting from 1, default is 1 if not provided.
8754
+ * The page number of the page to return. Pages start from page 1. Default value: 1.
8026
8755
  *
8027
8756
  * @example
8028
8757
  * 1
@@ -8030,46 +8759,91 @@ export declare class ListHttpApisRequest extends $dara.Model {
8030
8759
  pageNumber?: number;
8031
8760
  /**
8032
8761
  * @remarks
8033
- * Page size, valid range [1, 100], default is 10 if not provided.
8762
+ * The number of entries per page. Valid values: 1 to 100. Default value: 10.
8034
8763
  *
8035
8764
  * @example
8036
8765
  * 10
8037
8766
  */
8038
8767
  pageSize?: number;
8768
+ /**
8769
+ * @remarks
8770
+ * The resource group ID.
8771
+ *
8772
+ * @example
8773
+ * rg-ahr5uil8raz0rq3b
8774
+ */
8039
8775
  resourceGroupId?: string;
8040
8776
  /**
8041
8777
  * @remarks
8042
- * Type of HTTP API. Supports multiple types, separated by ",".
8043
- * - Http
8044
- * - Rest
8045
- * - WebSocket
8046
- * - HttpIngress
8778
+ * The API type. You can specify multiple types and separate them with a comma (,).
8779
+ *
8780
+ * * Http
8781
+ * * Rest
8782
+ * * WebSocket
8783
+ * * HttpIngress
8047
8784
  *
8048
8785
  * @example
8049
8786
  * Http,Rest
8050
8787
  */
8051
8788
  types?: string;
8789
+ withAPIsPublishedToEnvironment?: boolean;
8052
8790
  /**
8053
8791
  * @remarks
8054
- * Each API information in the response carries consumer authentication policy information under the specified environment ID.
8792
+ * The consumer authentication policy in the specified environment in each returned API.
8055
8793
  *
8056
8794
  * @example
8057
8795
  * env-xxx
8058
8796
  */
8059
8797
  withAuthPolicyInEnvironmentId?: string;
8798
+ /**
8799
+ * @remarks
8800
+ * Specifies whether authentication is enabled.
8801
+ *
8802
+ * @example
8803
+ * true
8804
+ */
8060
8805
  withAuthPolicyList?: boolean;
8061
8806
  /**
8062
8807
  * @remarks
8063
- * Each API information in the response carries a list of authorization rules for the specified consumer ID.
8808
+ * The authorization rules of the specified consumer in each returned API.
8064
8809
  *
8065
8810
  * @example
8066
8811
  * cs-xxx
8067
8812
  */
8068
8813
  withConsumerInfoById?: string;
8814
+ /**
8815
+ * @remarks
8816
+ * The environment information.
8817
+ *
8818
+ * @example
8819
+ * true
8820
+ */
8069
8821
  withEnvironmentInfo?: boolean;
8822
+ /**
8823
+ * @remarks
8824
+ * The environment ID.
8825
+ *
8826
+ * @example
8827
+ * env-ctovu5mm1hksb4q8ln40
8828
+ */
8070
8829
  withEnvironmentInfoById?: string;
8830
+ /**
8831
+ * @remarks
8832
+ * The Ingress information.
8833
+ *
8834
+ * @example
8835
+ * false
8836
+ */
8071
8837
  withIngressInfo?: boolean;
8838
+ /**
8839
+ * @remarks
8840
+ * The plug-in ID. You can use the returned value of this parameter to query the plug-in.
8841
+ *
8842
+ * @example
8843
+ * pl-ct9qn3um1hktue8dqol0
8844
+ */
8072
8845
  withPluginAttachmentByPluginId?: string;
8846
+ withPolicyConfigs?: boolean;
8073
8847
  static names(): {
8074
8848
  [key: string]: string;
8075
8849
  };
@@ -8084,7 +8858,7 @@ export declare class ListHttpApisRequest extends $dara.Model {
8084
8858
  export declare class ListHttpApisResponseBody extends $dara.Model {
8085
8859
  /**
8086
8860
  * @remarks
8087
- * Response status code.
8861
+ * The status code.
8088
8862
  *
8089
8863
  * @example
8090
8864
  * Ok
@@ -8092,12 +8866,12 @@ export declare class ListHttpApisResponseBody extends $dara.Model {
8092
8866
  code?: string;
8093
8867
  /**
8094
8868
  * @remarks
8095
- * API list.
8869
+ * The APIs.
8096
8870
  */
8097
8871
  data?: ListHttpApisResponseBodyData;
8098
8872
  /**
8099
8873
  * @remarks
8100
- * Response message.
8874
+ * The returned message.
8101
8875
  *
8102
8876
  * @example
8103
8877
  * success
@@ -8105,7 +8879,7 @@ export declare class ListHttpApisResponseBody extends $dara.Model {
8105
8879
  message?: string;
8106
8880
  /**
8107
8881
  * @remarks
8108
- * Request ID.
8882
+ * The request ID.
8109
8883
  *
8110
8884
  * @example
8111
8885
  * 585657D2-1C20-5B8A-AF17-D727C6490BE4
@@ -8141,26 +8915,52 @@ export declare class ListHttpApisResponse extends $dara.Model {
8141
8915
  }
8142
8916
  export declare class ListPolicyClassesRequest extends $dara.Model {
8143
8917
  /**
8918
+ * @remarks
8919
+ * Types of attachment points supported by the policy.
8920
+ *
8921
+ * - HttpApi: HttpApi.
8922
+ * - Operation: Operation of HttpApi.
8923
+ * - GatewayRoute: Gateway route.
8924
+ * - GatewayService: Gateway service.
8925
+ * - GatewayServicePort: Gateway service port.
8926
+ * - Domain: Gateway domain.
8927
+ * - Gateway: Gateway.
8928
+ *
8144
8929
  * @example
8145
8930
  * Operation
8146
8931
  */
8147
8932
  attachResourceType?: string;
8148
8933
  /**
8934
+ * @remarks
8935
+ * Direction of the policy.
8936
+ * - Outbound: OutBound.
8937
+ * - Inbound: InBound.
8938
+ * - Both directions: Both.
8939
+ *
8149
8940
  * @example
8150
8941
  * InBound
8151
8942
  */
8152
8943
  direction?: string;
8153
8944
  /**
8945
+ * @remarks
8946
+ * Page number, default is 1.
8947
+ *
8154
8948
  * @example
8155
8949
  * 1
8156
8950
  */
8157
8951
  pageNumber?: number;
8158
8952
  /**
8953
+ * @remarks
8954
+ * Page size
8955
+ *
8159
8956
  * @example
8160
8957
  * 10
8161
8958
  */
8162
8959
  pageSize?: number;
8163
8960
  /**
8961
+ * @remarks
8962
+ * Type of the policy template.
8963
+ *
8164
8964
  * @example
8165
8965
  * FlowControl
8166
8966
  */
@@ -8178,17 +8978,30 @@ export declare class ListPolicyClassesRequest extends $dara.Model {
8178
8978
  }
8179
8979
  export declare class ListPolicyClassesResponseBody extends $dara.Model {
8180
8980
  /**
8981
+ * @remarks
8982
+ * Response code.
8983
+ *
8181
8984
  * @example
8182
8985
  * Ok
8183
8986
  */
8184
8987
  code?: string;
8988
+ /**
8989
+ * @remarks
8990
+ * Policy template information.
8991
+ */
8185
8992
  data?: ListPolicyClassesResponseBodyData;
8186
8993
  /**
8994
+ * @remarks
8995
+ * ResponseMessage
8996
+ *
8187
8997
  * @example
8188
8998
  * success
8189
8999
  */
8190
9000
  message?: string;
8191
9001
  /**
9002
+ * @remarks
9003
+ * Request ID.
9004
+ *
8192
9005
  * @example
8193
9006
  * 23B45FA9-7208-5E55-B5CE-B6B2567DD822
8194
9007
  */
@@ -8223,27 +9036,63 @@ export declare class ListPolicyClassesResponse extends $dara.Model {
8223
9036
  }
8224
9037
  export declare class ListServicesRequest extends $dara.Model {
8225
9038
  /**
9039
+ * @remarks
9040
+ * The ID of the Cloud-native API Gateway instance.
9041
+ *
8226
9042
  * @example
8227
9043
  * gw-cpv4sqdl*****
8228
9044
  */
8229
9045
  gatewayId?: string;
8230
9046
  /**
9047
+ * @remarks
9048
+ * The service name.
9049
+ *
8231
9050
  * @example
8232
9051
  * user-service
8233
9052
  */
8234
9053
  name?: string;
8235
9054
  /**
9055
+ * @remarks
9056
+ * The page number to return. Pages start from page 1. Default value: 1.
9057
+ *
8236
9058
  * @example
8237
9059
  * 1
8238
9060
  */
8239
9061
  pageNumber?: number;
8240
9062
  /**
9063
+ * @remarks
9064
+ * The number of entries per page. Valid values: 1 to 100. Default value: 10.
9065
+ *
8241
9066
  * @example
8242
9067
  * 10
8243
9068
  */
8244
9069
  pageSize?: number;
9070
+ /**
9071
+ * @remarks
9072
+ * The resource group ID.
9073
+ *
9074
+ * @example
9075
+ * rg-acfmxxe5rc6cvla
9076
+ */
8245
9077
  resourceGroupId?: string;
8246
9078
  /**
9079
+ * @remarks
9080
+ * The service source. Valid values:
9081
+ *
9082
+ * * MSE_NACOS: a service in an MSE Nacos instance
9083
+ * * K8S: a service in a Kubernetes (K8s) cluster in Container Service for Kubernetes (ACK)
9084
+ * * FC3: a service in Function Compute
9085
+ * * VIP: a fixed address
9086
+ * * DNS: a domain name
9087
+ *
9088
+ * Enumerated values:
9089
+ *
9090
+ * * K8S
9091
+ * * FC3
9092
+ * * DNS
9093
+ * * VIP
9094
+ * * MSE_NACOS
9095
+ *
8247
9096
  * @example
8248
9097
  * MSE_NACOS
8249
9098
  */
@@ -8261,17 +9110,30 @@ export declare class ListServicesRequest extends $dara.Model {
8261
9110
  }
8262
9111
  export declare class ListServicesResponseBody extends $dara.Model {
8263
9112
  /**
9113
+ * @remarks
9114
+ * The status code.
9115
+ *
8264
9116
  * @example
8265
9117
  * Ok
8266
9118
  */
8267
9119
  code?: string;
9120
+ /**
9121
+ * @remarks
9122
+ * The response parameters.
9123
+ */
8268
9124
  data?: ListServicesResponseBodyData;
8269
9125
  /**
9126
+ * @remarks
9127
+ * The returned message.
9128
+ *
8270
9129
  * @example
8271
9130
  * success
8272
9131
  */
8273
9132
  message?: string;
8274
9133
  /**
9134
+ * @remarks
9135
+ * The request ID.
9136
+ *
8275
9137
  * @example
8276
9138
  * 585657D2-1C20-5B8A-AF17-D727C6490BE4
8277
9139
  */
@@ -8306,21 +9168,33 @@ export declare class ListServicesResponse extends $dara.Model {
8306
9168
  }
8307
9169
  export declare class ListSslCertsRequest extends $dara.Model {
8308
9170
  /**
9171
+ * @remarks
9172
+ * Name matching keyword.
9173
+ *
8309
9174
  * @example
8310
9175
  * ali
8311
9176
  */
8312
9177
  certNameLike?: string;
8313
9178
  /**
9179
+ * @remarks
9180
+ * Domain name.
9181
+ *
8314
9182
  * @example
8315
9183
  * fun.iot.evideocloud.com.cn
8316
9184
  */
8317
9185
  domainName?: string;
8318
9186
  /**
9187
+ * @remarks
9188
+ * Page number, default is 1
9189
+ *
8319
9190
  * @example
8320
9191
  * 1
8321
9192
  */
8322
9193
  pageNumber?: number;
8323
9194
  /**
9195
+ * @remarks
9196
+ * Page size, default is 10
9197
+ *
8324
9198
  * @example
8325
9199
  * 10
8326
9200
  */
@@ -8338,17 +9212,30 @@ export declare class ListSslCertsRequest extends $dara.Model {
8338
9212
  }
8339
9213
  export declare class ListSslCertsResponseBody extends $dara.Model {
8340
9214
  /**
9215
+ * @remarks
9216
+ * Response status code.
9217
+ *
8341
9218
  * @example
8342
9219
  * Ok
8343
9220
  */
8344
9221
  code?: string;
9222
+ /**
9223
+ * @remarks
9224
+ * Returned data
9225
+ */
8345
9226
  data?: ListSslCertsResponseBodyData;
8346
9227
  /**
9228
+ * @remarks
9229
+ * Response message.
9230
+ *
8347
9231
  * @example
8348
9232
  * success
8349
9233
  */
8350
9234
  message?: string;
8351
9235
  /**
9236
+ * @remarks
9237
+ * Request ID.
9238
+ *
8352
9239
  * @example
8353
9240
  * AADF7197-3384-52AF-A2DE-A66696734129
8354
9241
  */
@@ -8383,17 +9270,30 @@ export declare class ListSslCertsResponse extends $dara.Model {
8383
9270
  }
8384
9271
  export declare class ListZonesResponseBody extends $dara.Model {
8385
9272
  /**
9273
+ * @remarks
9274
+ * Response status code.
9275
+ *
8386
9276
  * @example
8387
9277
  * Ok
8388
9278
  */
8389
9279
  code?: string;
9280
+ /**
9281
+ * @remarks
9282
+ * Returned data.
9283
+ */
8390
9284
  data?: ListZonesResponseBodyData;
8391
9285
  /**
9286
+ * @remarks
9287
+ * Response message.
9288
+ *
8392
9289
  * @example
8393
9290
  * success
8394
9291
  */
8395
9292
  message?: string;
8396
9293
  /**
9294
+ * @remarks
9295
+ * Request ID.
9296
+ *
8397
9297
  * @example
8398
9298
  * E8079207-B651-592A-A565-23E9EE5673B0
8399
9299
  */
@@ -8479,12 +9379,119 @@ export declare class RestartGatewayResponse extends $dara.Model {
8479
9379
  [key: string]: any;
8480
9380
  });
8481
9381
  }
9382
+ export declare class UndeployHttpApiRequest extends $dara.Model {
9383
+ /**
9384
+ * @remarks
9385
+ * The environment ID.
9386
+ *
9387
+ * @example
9388
+ * env-cqsmtellhtgvo***
9389
+ */
9390
+ environmentId?: string;
9391
+ /**
9392
+ * @remarks
9393
+ * Route ID. This must be provided when publishing the route of an HTTP API.
9394
+ *
9395
+ * @example
9396
+ * hr-cr82undlhtgrle***
9397
+ */
9398
+ routeId?: string;
9399
+ static names(): {
9400
+ [key: string]: string;
9401
+ };
9402
+ static types(): {
9403
+ [key: string]: any;
9404
+ };
9405
+ validate(): void;
9406
+ constructor(map?: {
9407
+ [key: string]: any;
9408
+ });
9409
+ }
9410
+ export declare class UndeployHttpApiResponseBody extends $dara.Model {
9411
+ /**
9412
+ * @remarks
9413
+ * Response code.
9414
+ *
9415
+ * @example
9416
+ * Ok
9417
+ */
9418
+ code?: string;
9419
+ /**
9420
+ * @remarks
9421
+ * Response message.
9422
+ *
9423
+ * @example
9424
+ * success
9425
+ */
9426
+ message?: string;
9427
+ /**
9428
+ * @remarks
9429
+ * Request ID.
9430
+ *
9431
+ * @example
9432
+ * 3ACFC7A7-45A9-58CF-B2D5-765B60254695
9433
+ */
9434
+ requestId?: string;
9435
+ static names(): {
9436
+ [key: string]: string;
9437
+ };
9438
+ static types(): {
9439
+ [key: string]: any;
9440
+ };
9441
+ validate(): void;
9442
+ constructor(map?: {
9443
+ [key: string]: any;
9444
+ });
9445
+ }
9446
+ export declare class UndeployHttpApiResponse extends $dara.Model {
9447
+ headers?: {
9448
+ [key: string]: string;
9449
+ };
9450
+ statusCode?: number;
9451
+ body?: UndeployHttpApiResponseBody;
9452
+ static names(): {
9453
+ [key: string]: string;
9454
+ };
9455
+ static types(): {
9456
+ [key: string]: any;
9457
+ };
9458
+ validate(): void;
9459
+ constructor(map?: {
9460
+ [key: string]: any;
9461
+ });
9462
+ }
8482
9463
  export declare class UpdateDomainRequest extends $dara.Model {
9464
+ /**
9465
+ * @remarks
9466
+ * The CA certificate ID.
9467
+ *
9468
+ * @example
9469
+ * 1ef1da5f-38ed-69b3-****-037781890265
9470
+ */
8483
9471
  caCertIdentifier?: string;
9472
+ /**
9473
+ * @remarks
9474
+ * The certificate ID.
9475
+ *
9476
+ * @example
9477
+ * 1ef1da5f-38ed-69b3-****-037781890265
9478
+ */
8484
9479
  certIdentifier?: string;
8485
9480
  /**
8486
9481
  * @remarks
8487
- * Set the HTTPS protocol type, whether to enable forced HTTPS redirection.
9482
+ * The client CA certificate.
9483
+ *
9484
+ * @example
9485
+ * -----BEGIN CERTIFICATE-----
9486
+ * MIIFBTCCAu2gAwIBAgIUORLpYPGSFD1YOP6PMbE7Wd/mpTQwDQYJKoZIhvcNAQEL
9487
+ * BQAwE************************************************2VwVOJ2gqX3
9488
+ * YuGaxvIbDy0iQJ1GMerPRyzJTeVEtdIKT29u0PdFRr4KZWom35qX7G4=
9489
+ * -----END CERTIFICATE-----
9490
+ */
9491
+ clientCACert?: string;
9492
+ /**
9493
+ * @remarks
9494
+ * Specifies whether to enable HTTPS redirection. If protocol is set to HTTPS, forceHttps is required.
8488
9495
  *
8489
9496
  * @example
8490
9497
  * false
@@ -8492,7 +9499,13 @@ export declare class UpdateDomainRequest extends $dara.Model {
8492
9499
  forceHttps?: boolean;
8493
9500
  /**
8494
9501
  * @remarks
8495
- * HTTP/2 settings.
9502
+ * The HTTP/2 configuration.
9503
+ *
9504
+ * Enumerated values:
9505
+ *
9506
+ * * GlobalConfig
9507
+ * * Close
9508
+ * * Open
8496
9509
  *
8497
9510
  * @example
8498
9511
  * Open
@@ -8500,10 +9513,15 @@ export declare class UpdateDomainRequest extends $dara.Model {
8500
9513
  http2Option?: string;
8501
9514
  /**
8502
9515
  * @remarks
8503
- * The protocol type supported by the domain.
9516
+ * Specifies whether to enable mutual TLS (mTLS) authentication.
9517
+ */
9518
+ mTLSEnabled?: boolean;
9519
+ /**
9520
+ * @remarks
9521
+ * The protocol type to be supported by the domain name. Valid values:
8504
9522
  *
8505
- * - HTTP: Supports only HTTP protocol.
8506
- * - HTTPS: Supports only HTTPS protocol.
9523
+ * * HTTP
9524
+ * * HTTPS
8507
9525
  *
8508
9526
  * This parameter is required.
8509
9527
  *
@@ -8513,12 +9531,12 @@ export declare class UpdateDomainRequest extends $dara.Model {
8513
9531
  protocol?: string;
8514
9532
  /**
8515
9533
  * @remarks
8516
- * TLS Cipher Suite Configuration.
9534
+ * The cipher suite configuration.
8517
9535
  */
8518
9536
  tlsCipherSuitesConfig?: TlsCipherSuitesConfig;
8519
9537
  /**
8520
9538
  * @remarks
8521
- * Maximum TLS protocol version, supports up to TLS 1.3.
9539
+ * The maximum TLS version. Up to TLS 1.3 is supported.
8522
9540
  *
8523
9541
  * @example
8524
9542
  * TLS 1.3
@@ -8526,7 +9544,7 @@ export declare class UpdateDomainRequest extends $dara.Model {
8526
9544
  tlsMax?: string;
8527
9545
  /**
8528
9546
  * @remarks
8529
- * Minimum TLS protocol version, supports down to TLS 1.0.
9547
+ * The minimum TLS version. Down to TLS 1.0 is supported.
8530
9548
  *
8531
9549
  * @example
8532
9550
  * TLS 1.0
@@ -8546,7 +9564,7 @@ export declare class UpdateDomainRequest extends $dara.Model {
8546
9564
  export declare class UpdateDomainResponseBody extends $dara.Model {
8547
9565
  /**
8548
9566
  * @remarks
8549
- * Response code.
9567
+ * The status code.
8550
9568
  *
8551
9569
  * @example
8552
9570
  * Ok
@@ -8554,12 +9572,12 @@ export declare class UpdateDomainResponseBody extends $dara.Model {
8554
9572
  code?: string;
8555
9573
  /**
8556
9574
  * @remarks
8557
- * The returned data.
9575
+ * The response parameters.
8558
9576
  */
8559
9577
  data?: UpdateDomainResponseBodyData;
8560
9578
  /**
8561
9579
  * @remarks
8562
- * Response message.
9580
+ * The returned message.
8563
9581
  *
8564
9582
  * @example
8565
9583
  * success
@@ -8567,7 +9585,7 @@ export declare class UpdateDomainResponseBody extends $dara.Model {
8567
9585
  message?: string;
8568
9586
  /**
8569
9587
  * @remarks
8570
- * Request ID, used for tracing the API call chain.
9588
+ * The request ID. You can use this value to trace the API call.
8571
9589
  *
8572
9590
  * @example
8573
9591
  * 4BACB05C-3FE2-588F-9148-700C5C026B74
@@ -8833,13 +9851,17 @@ export declare class UpdateGatewayNameResponse extends $dara.Model {
8833
9851
  export declare class UpdateHttpApiRequest extends $dara.Model {
8834
9852
  /**
8835
9853
  * @remarks
8836
- * List of AI protocols.
9854
+ * The AI protocols.
8837
9855
  */
8838
9856
  aiProtocols?: string[];
9857
+ /**
9858
+ * @remarks
9859
+ * The authentication configuration.
9860
+ */
8839
9861
  authConfig?: AuthConfig;
8840
9862
  /**
8841
9863
  * @remarks
8842
- * Base path of the API, which must start with a \\"/\\".
9864
+ * The API base path, which must start with a forward slash (/).
8843
9865
  *
8844
9866
  * This parameter is required.
8845
9867
  *
@@ -8849,31 +9871,35 @@ export declare class UpdateHttpApiRequest extends $dara.Model {
8849
9871
  basePath?: string;
8850
9872
  /**
8851
9873
  * @remarks
8852
- * List of API deployment configurations.
9874
+ * The deployment configurations.
8853
9875
  */
8854
9876
  deployConfigs?: HttpApiDeployConfig[];
8855
9877
  /**
8856
9878
  * @remarks
8857
- * API description.
9879
+ * The API description.
8858
9880
  *
8859
9881
  * @example
8860
- * 更新API描述
9882
+ * API for testing
8861
9883
  */
8862
9884
  description?: string;
9885
+ /**
9886
+ * @remarks
9887
+ * Specifies whether to enable authentication.
9888
+ */
8863
9889
  enableAuth?: boolean;
8864
9890
  /**
8865
9891
  * @remarks
8866
- * Configuration information for the HTTP Ingress API.
9892
+ * The HTTP Ingress API configurations.
8867
9893
  */
8868
9894
  ingressConfig?: UpdateHttpApiRequestIngressConfig;
8869
9895
  /**
8870
9896
  * @remarks
8871
- * List of API access protocols.
9897
+ * The protocols that are used to access the API.
8872
9898
  */
8873
9899
  protocols?: string[];
8874
9900
  /**
8875
9901
  * @remarks
8876
- * API versioning configuration.
9902
+ * The versioning configurations.
8877
9903
  */
8878
9904
  versionConfig?: HttpApiVersionConfig;
8879
9905
  static names(): {
@@ -8890,7 +9916,7 @@ export declare class UpdateHttpApiRequest extends $dara.Model {
8890
9916
  export declare class UpdateHttpApiResponseBody extends $dara.Model {
8891
9917
  /**
8892
9918
  * @remarks
8893
- * Response status code.
9919
+ * The status code.
8894
9920
  *
8895
9921
  * @example
8896
9922
  * Ok
@@ -8898,7 +9924,7 @@ export declare class UpdateHttpApiResponseBody extends $dara.Model {
8898
9924
  code?: string;
8899
9925
  /**
8900
9926
  * @remarks
8901
- * Response message.
9927
+ * The returned message.
8902
9928
  *
8903
9929
  * @example
8904
9930
  * success
@@ -8906,7 +9932,7 @@ export declare class UpdateHttpApiResponseBody extends $dara.Model {
8906
9932
  message?: string;
8907
9933
  /**
8908
9934
  * @remarks
8909
- * Request ID.
9935
+ * The request ID.
8910
9936
  *
8911
9937
  * @example
8912
9938
  * 393E2630-DBE7-5221-AB35-9E740675491A
@@ -9013,12 +10039,12 @@ export declare class UpdateHttpApiOperationResponse extends $dara.Model {
9013
10039
  export declare class UpdateHttpApiRouteRequest extends $dara.Model {
9014
10040
  /**
9015
10041
  * @remarks
9016
- * Backend service configuration for the route.
10042
+ * The backend service configurations of the route.
9017
10043
  */
9018
10044
  backendConfig?: UpdateHttpApiRouteRequestBackendConfig;
9019
10045
  /**
9020
10046
  * @remarks
9021
- * Route description.
10047
+ * The route description.
9022
10048
  *
9023
10049
  * @example
9024
10050
  * test route
@@ -9026,12 +10052,12 @@ export declare class UpdateHttpApiRouteRequest extends $dara.Model {
9026
10052
  description?: string;
9027
10053
  /**
9028
10054
  * @remarks
9029
- * List of domain IDs.
10055
+ * The domain IDs.
9030
10056
  */
9031
10057
  domainIds?: string[];
9032
10058
  /**
9033
10059
  * @remarks
9034
- * Environment ID.
10060
+ * The environment ID.
9035
10061
  *
9036
10062
  * @example
9037
10063
  * env-cquqsollhtgid***
@@ -9039,7 +10065,7 @@ export declare class UpdateHttpApiRouteRequest extends $dara.Model {
9039
10065
  environmentId?: string;
9040
10066
  /**
9041
10067
  * @remarks
9042
- * Route match rule.
10068
+ * The rules for matching the route.
9043
10069
  */
9044
10070
  match?: HttpRouteMatch;
9045
10071
  static names(): {
@@ -9056,7 +10082,7 @@ export declare class UpdateHttpApiRouteRequest extends $dara.Model {
9056
10082
  export declare class UpdateHttpApiRouteResponseBody extends $dara.Model {
9057
10083
  /**
9058
10084
  * @remarks
9059
- * Response status code.
10085
+ * The status code.
9060
10086
  *
9061
10087
  * @example
9062
10088
  * Ok
@@ -9064,7 +10090,7 @@ export declare class UpdateHttpApiRouteResponseBody extends $dara.Model {
9064
10090
  code?: string;
9065
10091
  /**
9066
10092
  * @remarks
9067
- * Response message.
10093
+ * The returned message.
9068
10094
  *
9069
10095
  * @example
9070
10096
  * success
@@ -9072,7 +10098,7 @@ export declare class UpdateHttpApiRouteResponseBody extends $dara.Model {
9072
10098
  message?: string;
9073
10099
  /**
9074
10100
  * @remarks
9075
- * Request ID.
10101
+ * The request ID.
9076
10102
  *
9077
10103
  * @example
9078
10104
  * CBEEB8C1-108E-50F0-9BEA-DED79553C309
@@ -9109,15 +10135,26 @@ export declare class UpdateHttpApiRouteResponse extends $dara.Model {
9109
10135
  export declare class UpdatePolicyRequest extends $dara.Model {
9110
10136
  /**
9111
10137
  * @remarks
10138
+ * Policy configuration
10139
+ *
9112
10140
  * This parameter is required.
9113
10141
  *
9114
10142
  * @example
9115
10143
  * {"unitNum":1,"timeUnit":"s","enable":true}
9116
10144
  */
9117
10145
  config?: string;
10146
+ /**
10147
+ * @remarks
10148
+ * Description
10149
+ *
10150
+ * @example
10151
+ * this is a timeout policy description
10152
+ */
9118
10153
  description?: string;
9119
10154
  /**
9120
10155
  * @remarks
10156
+ * Policy name
10157
+ *
9121
10158
  * This parameter is required.
9122
10159
  *
9123
10160
  * @example
@@ -9137,16 +10174,25 @@ export declare class UpdatePolicyRequest extends $dara.Model {
9137
10174
  }
9138
10175
  export declare class UpdatePolicyResponseBody extends $dara.Model {
9139
10176
  /**
10177
+ * @remarks
10178
+ * Response status code.
10179
+ *
9140
10180
  * @example
9141
10181
  * Ok
9142
10182
  */
9143
10183
  code?: string;
9144
10184
  /**
10185
+ * @remarks
10186
+ * Response message.
10187
+ *
9145
10188
  * @example
9146
10189
  * success
9147
10190
  */
9148
10191
  message?: string;
9149
10192
  /**
10193
+ * @remarks
10194
+ * Request ID.
10195
+ *
9150
10196
  * @example
9151
10197
  * C67DED2B-F19B-5BEC-88C1-D6EB854C***
9152
10198
  */
@@ -9276,7 +10322,7 @@ export default class Client extends OpenApi {
9276
10322
  */
9277
10323
  addGatewaySecurityGroupRule(gatewayId: string, request: AddGatewaySecurityGroupRuleRequest): Promise<AddGatewaySecurityGroupRuleResponse>;
9278
10324
  /**
9279
- * 资源转组
10325
+ * Resource Group Transfer
9280
10326
  *
9281
10327
  * @param request - ChangeResourceGroupRequest
9282
10328
  * @param headers - map
@@ -9287,14 +10333,14 @@ export default class Client extends OpenApi {
9287
10333
  [key: string]: string;
9288
10334
  }, runtime: $dara.RuntimeOptions): Promise<ChangeResourceGroupResponse>;
9289
10335
  /**
9290
- * 资源转组
10336
+ * Resource Group Transfer
9291
10337
  *
9292
10338
  * @param request - ChangeResourceGroupRequest
9293
10339
  * @returns ChangeResourceGroupResponse
9294
10340
  */
9295
10341
  changeResourceGroup(request: ChangeResourceGroupRequest): Promise<ChangeResourceGroupResponse>;
9296
10342
  /**
9297
- * Create Domain
10343
+ * Creates a domain name.
9298
10344
  *
9299
10345
  * @remarks
9300
10346
  * Create Domain.
@@ -9308,7 +10354,7 @@ export default class Client extends OpenApi {
9308
10354
  [key: string]: string;
9309
10355
  }, runtime: $dara.RuntimeOptions): Promise<CreateDomainResponse>;
9310
10356
  /**
9311
- * Create Domain
10357
+ * Creates a domain name.
9312
10358
  *
9313
10359
  * @remarks
9314
10360
  * Create Domain.
@@ -9346,7 +10392,7 @@ export default class Client extends OpenApi {
9346
10392
  */
9347
10393
  createEnvironment(request: CreateEnvironmentRequest): Promise<CreateEnvironmentResponse>;
9348
10394
  /**
9349
- * Create an API of HTTP type
10395
+ * Creates an HTTP API.
9350
10396
  *
9351
10397
  * @param request - CreateHttpApiRequest
9352
10398
  * @param headers - map
@@ -9357,7 +10403,7 @@ export default class Client extends OpenApi {
9357
10403
  [key: string]: string;
9358
10404
  }, runtime: $dara.RuntimeOptions): Promise<CreateHttpApiResponse>;
9359
10405
  /**
9360
- * Create an API of HTTP type
10406
+ * Creates an HTTP API.
9361
10407
  *
9362
10408
  * @param request - CreateHttpApiRequest
9363
10409
  * @returns CreateHttpApiResponse
@@ -9382,7 +10428,7 @@ export default class Client extends OpenApi {
9382
10428
  */
9383
10429
  createHttpApiOperation(httpApiId: string, request: CreateHttpApiOperationRequest): Promise<CreateHttpApiOperationResponse>;
9384
10430
  /**
9385
- * Create a route for HttpApi
10431
+ * Creates a route for an HTTP API.
9386
10432
  *
9387
10433
  * @param request - CreateHttpApiRouteRequest
9388
10434
  * @param headers - map
@@ -9393,14 +10439,14 @@ export default class Client extends OpenApi {
9393
10439
  [key: string]: string;
9394
10440
  }, runtime: $dara.RuntimeOptions): Promise<CreateHttpApiRouteResponse>;
9395
10441
  /**
9396
- * Create a route for HttpApi
10442
+ * Creates a route for an HTTP API.
9397
10443
  *
9398
10444
  * @param request - CreateHttpApiRouteRequest
9399
10445
  * @returns CreateHttpApiRouteResponse
9400
10446
  */
9401
10447
  createHttpApiRoute(httpApiId: string, request: CreateHttpApiRouteRequest): Promise<CreateHttpApiRouteResponse>;
9402
10448
  /**
9403
- * 创建策略
10449
+ * Create Policy
9404
10450
  *
9405
10451
  * @param request - CreatePolicyRequest
9406
10452
  * @param headers - map
@@ -9411,14 +10457,14 @@ export default class Client extends OpenApi {
9411
10457
  [key: string]: string;
9412
10458
  }, runtime: $dara.RuntimeOptions): Promise<CreatePolicyResponse>;
9413
10459
  /**
9414
- * 创建策略
10460
+ * Create Policy
9415
10461
  *
9416
10462
  * @param request - CreatePolicyRequest
9417
10463
  * @returns CreatePolicyResponse
9418
10464
  */
9419
10465
  createPolicy(request: CreatePolicyRequest): Promise<CreatePolicyResponse>;
9420
10466
  /**
9421
- * 创建策略资源挂载
10467
+ * Create policy resource mount
9422
10468
  *
9423
10469
  * @param request - CreatePolicyAttachmentRequest
9424
10470
  * @param headers - map
@@ -9429,14 +10475,17 @@ export default class Client extends OpenApi {
9429
10475
  [key: string]: string;
9430
10476
  }, runtime: $dara.RuntimeOptions): Promise<CreatePolicyAttachmentResponse>;
9431
10477
  /**
9432
- * 创建策略资源挂载
10478
+ * Create policy resource mount
9433
10479
  *
9434
10480
  * @param request - CreatePolicyAttachmentRequest
9435
10481
  * @returns CreatePolicyAttachmentResponse
9436
10482
  */
9437
10483
  createPolicyAttachment(request: CreatePolicyAttachmentRequest): Promise<CreatePolicyAttachmentResponse>;
9438
10484
  /**
9439
- * 创建服务
10485
+ * Creates a service.
10486
+ *
10487
+ * @remarks
10488
+ * You can call this operation to create multiple services at a time.
9440
10489
  *
9441
10490
  * @param request - CreateServiceRequest
9442
10491
  * @param headers - map
@@ -9447,7 +10496,10 @@ export default class Client extends OpenApi {
9447
10496
  [key: string]: string;
9448
10497
  }, runtime: $dara.RuntimeOptions): Promise<CreateServiceResponse>;
9449
10498
  /**
9450
- * 创建服务
10499
+ * Creates a service.
10500
+ *
10501
+ * @remarks
10502
+ * You can call this operation to create multiple services at a time.
9451
10503
  *
9452
10504
  * @param request - CreateServiceRequest
9453
10505
  * @returns CreateServiceResponse
@@ -9521,7 +10573,7 @@ export default class Client extends OpenApi {
9521
10573
  */
9522
10574
  deleteGatewaySecurityGroupRule(gatewayId: string, securityGroupRuleId: string, request: DeleteGatewaySecurityGroupRuleRequest): Promise<DeleteGatewaySecurityGroupRuleResponse>;
9523
10575
  /**
9524
- * Delete HTTP API
10576
+ * Deletes an HTTP API.
9525
10577
  *
9526
10578
  * @param headers - map
9527
10579
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9531,7 +10583,7 @@ export default class Client extends OpenApi {
9531
10583
  [key: string]: string;
9532
10584
  }, runtime: $dara.RuntimeOptions): Promise<DeleteHttpApiResponse>;
9533
10585
  /**
9534
- * Delete HTTP API
10586
+ * Deletes an HTTP API.
9535
10587
  * @returns DeleteHttpApiResponse
9536
10588
  */
9537
10589
  deleteHttpApi(httpApiId: string): Promise<DeleteHttpApiResponse>;
@@ -9566,7 +10618,7 @@ export default class Client extends OpenApi {
9566
10618
  */
9567
10619
  deleteHttpApiRoute(httpApiId: string, routeId: string): Promise<DeleteHttpApiRouteResponse>;
9568
10620
  /**
9569
- * 删除策略
10621
+ * Delete Policy
9570
10622
  *
9571
10623
  * @param headers - map
9572
10624
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9576,12 +10628,12 @@ export default class Client extends OpenApi {
9576
10628
  [key: string]: string;
9577
10629
  }, runtime: $dara.RuntimeOptions): Promise<DeletePolicyResponse>;
9578
10630
  /**
9579
- * 删除策略
10631
+ * Delete Policy
9580
10632
  * @returns DeletePolicyResponse
9581
10633
  */
9582
10634
  deletePolicy(policyId: string): Promise<DeletePolicyResponse>;
9583
10635
  /**
9584
- * 删除策略资源挂载
10636
+ * Delete policy resource attachment
9585
10637
  *
9586
10638
  * @param headers - map
9587
10639
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9591,12 +10643,12 @@ export default class Client extends OpenApi {
9591
10643
  [key: string]: string;
9592
10644
  }, runtime: $dara.RuntimeOptions): Promise<DeletePolicyAttachmentResponse>;
9593
10645
  /**
9594
- * 删除策略资源挂载
10646
+ * Delete policy resource attachment
9595
10647
  * @returns DeletePolicyAttachmentResponse
9596
10648
  */
9597
10649
  deletePolicyAttachment(policyAttachmentId: string): Promise<DeletePolicyAttachmentResponse>;
9598
10650
  /**
9599
- * 部署HttpApi
10651
+ * Deploy HttpApi
9600
10652
  *
9601
10653
  * @param request - DeployHttpApiRequest
9602
10654
  * @param headers - map
@@ -9607,7 +10659,7 @@ export default class Client extends OpenApi {
9607
10659
  [key: string]: string;
9608
10660
  }, runtime: $dara.RuntimeOptions): Promise<DeployHttpApiResponse>;
9609
10661
  /**
9610
- * 部署HttpApi
10662
+ * Deploy HttpApi
9611
10663
  *
9612
10664
  * @param request - DeployHttpApiRequest
9613
10665
  * @returns DeployHttpApiResponse
@@ -9629,7 +10681,7 @@ export default class Client extends OpenApi {
9629
10681
  */
9630
10682
  exportHttpApi(httpApiId: string): Promise<ExportHttpApiResponse>;
9631
10683
  /**
9632
- * 获取监控/日志大盘接口
10684
+ * Obtains data from dashboards.
9633
10685
  *
9634
10686
  * @param tmpReq - GetDashboardRequest
9635
10687
  * @param headers - map
@@ -9640,14 +10692,14 @@ export default class Client extends OpenApi {
9640
10692
  [key: string]: string;
9641
10693
  }, runtime: $dara.RuntimeOptions): Promise<GetDashboardResponse>;
9642
10694
  /**
9643
- * 获取监控/日志大盘接口
10695
+ * Obtains data from dashboards.
9644
10696
  *
9645
10697
  * @param request - GetDashboardRequest
9646
10698
  * @returns GetDashboardResponse
9647
10699
  */
9648
10700
  getDashboard(gatewayId: string, request: GetDashboardRequest): Promise<GetDashboardResponse>;
9649
10701
  /**
9650
- * Query domain details
10702
+ * Queries the information about a domain name.
9651
10703
  *
9652
10704
  * @param request - GetDomainRequest
9653
10705
  * @param headers - map
@@ -9658,7 +10710,7 @@ export default class Client extends OpenApi {
9658
10710
  [key: string]: string;
9659
10711
  }, runtime: $dara.RuntimeOptions): Promise<GetDomainResponse>;
9660
10712
  /**
9661
- * Query domain details
10713
+ * Queries the information about a domain name.
9662
10714
  *
9663
10715
  * @param request - GetDomainRequest
9664
10716
  * @returns GetDomainResponse
@@ -9732,7 +10784,7 @@ export default class Client extends OpenApi {
9732
10784
  */
9733
10785
  getHttpApiOperation(httpApiId: string, operationId: string): Promise<GetHttpApiOperationResponse>;
9734
10786
  /**
9735
- * Get the details of an HttpApi route
10787
+ * Queries the details of a route of an HTTP API.
9736
10788
  *
9737
10789
  * @param headers - map
9738
10790
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9742,12 +10794,12 @@ export default class Client extends OpenApi {
9742
10794
  [key: string]: string;
9743
10795
  }, runtime: $dara.RuntimeOptions): Promise<GetHttpApiRouteResponse>;
9744
10796
  /**
9745
- * Get the details of an HttpApi route
10797
+ * Queries the details of a route of an HTTP API.
9746
10798
  * @returns GetHttpApiRouteResponse
9747
10799
  */
9748
10800
  getHttpApiRoute(httpApiId: string, routeId: string): Promise<GetHttpApiRouteResponse>;
9749
10801
  /**
9750
- * GetPolicy
10802
+ * Queries a policy.
9751
10803
  *
9752
10804
  * @param headers - map
9753
10805
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9757,12 +10809,12 @@ export default class Client extends OpenApi {
9757
10809
  [key: string]: string;
9758
10810
  }, runtime: $dara.RuntimeOptions): Promise<GetPolicyResponse>;
9759
10811
  /**
9760
- * GetPolicy
10812
+ * Queries a policy.
9761
10813
  * @returns GetPolicyResponse
9762
10814
  */
9763
10815
  getPolicy(policyId: string): Promise<GetPolicyResponse>;
9764
10816
  /**
9765
- * 查询策略资源挂载
10817
+ * Query Policy Resource Attachment
9766
10818
  *
9767
10819
  * @param headers - map
9768
10820
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9772,12 +10824,12 @@ export default class Client extends OpenApi {
9772
10824
  [key: string]: string;
9773
10825
  }, runtime: $dara.RuntimeOptions): Promise<GetPolicyAttachmentResponse>;
9774
10826
  /**
9775
- * 查询策略资源挂载
10827
+ * Query Policy Resource Attachment
9776
10828
  * @returns GetPolicyAttachmentResponse
9777
10829
  */
9778
10830
  getPolicyAttachment(policyAttachmentId: string): Promise<GetPolicyAttachmentResponse>;
9779
10831
  /**
9780
- * 获取资源概览信息
10832
+ * Get resource overview information
9781
10833
  *
9782
10834
  * @param headers - map
9783
10835
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9787,12 +10839,12 @@ export default class Client extends OpenApi {
9787
10839
  [key: string]: string;
9788
10840
  }, runtime: $dara.RuntimeOptions): Promise<GetResourceOverviewResponse>;
9789
10841
  /**
9790
- * 获取资源概览信息
10842
+ * Get resource overview information
9791
10843
  * @returns GetResourceOverviewResponse
9792
10844
  */
9793
10845
  getResourceOverview(): Promise<GetResourceOverviewResponse>;
9794
10846
  /**
9795
- * 获取服务详情
10847
+ * Queries the details of a service.
9796
10848
  *
9797
10849
  * @param headers - map
9798
10850
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9802,12 +10854,12 @@ export default class Client extends OpenApi {
9802
10854
  [key: string]: string;
9803
10855
  }, runtime: $dara.RuntimeOptions): Promise<GetServiceResponse>;
9804
10856
  /**
9805
- * 获取服务详情
10857
+ * Queries the details of a service.
9806
10858
  * @returns GetServiceResponse
9807
10859
  */
9808
10860
  getService(serviceId: string): Promise<GetServiceResponse>;
9809
10861
  /**
9810
- * 获取链路追踪配置
10862
+ * Retrieve Tracing Configuration
9811
10863
  *
9812
10864
  * @param request - GetTraceConfigRequest
9813
10865
  * @param headers - map
@@ -9818,14 +10870,14 @@ export default class Client extends OpenApi {
9818
10870
  [key: string]: string;
9819
10871
  }, runtime: $dara.RuntimeOptions): Promise<GetTraceConfigResponse>;
9820
10872
  /**
9821
- * 获取链路追踪配置
10873
+ * Retrieve Tracing Configuration
9822
10874
  *
9823
10875
  * @param request - GetTraceConfigRequest
9824
10876
  * @returns GetTraceConfigResponse
9825
10877
  */
9826
10878
  getTraceConfig(gatewayId: string, request: GetTraceConfigRequest): Promise<GetTraceConfigResponse>;
9827
10879
  /**
9828
- * Import HttpApi
10880
+ * Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs.
9829
10881
  *
9830
10882
  * @param request - ImportHttpApiRequest
9831
10883
  * @param headers - map
@@ -9836,14 +10888,14 @@ export default class Client extends OpenApi {
9836
10888
  [key: string]: string;
9837
10889
  }, runtime: $dara.RuntimeOptions): Promise<ImportHttpApiResponse>;
9838
10890
  /**
9839
- * Import HttpApi
10891
+ * Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs.
9840
10892
  *
9841
10893
  * @param request - ImportHttpApiRequest
9842
10894
  * @returns ImportHttpApiResponse
9843
10895
  */
9844
10896
  importHttpApi(request: ImportHttpApiRequest): Promise<ImportHttpApiResponse>;
9845
10897
  /**
9846
- * ListDomains
10898
+ * Queries a list of domain names.
9847
10899
  *
9848
10900
  * @param request - ListDomainsRequest
9849
10901
  * @param headers - map
@@ -9854,7 +10906,7 @@ export default class Client extends OpenApi {
9854
10906
  [key: string]: string;
9855
10907
  }, runtime: $dara.RuntimeOptions): Promise<ListDomainsResponse>;
9856
10908
  /**
9857
- * ListDomains
10909
+ * Queries a list of domain names.
9858
10910
  *
9859
10911
  * @param request - ListDomainsRequest
9860
10912
  * @returns ListDomainsResponse
@@ -9883,7 +10935,7 @@ export default class Client extends OpenApi {
9883
10935
  */
9884
10936
  listEnvironments(request: ListEnvironmentsRequest): Promise<ListEnvironmentsResponse>;
9885
10937
  /**
9886
- * Retrieve the list of created cloud-native gateways
10938
+ * Queries a list of instances.
9887
10939
  *
9888
10940
  * @param tmpReq - ListGatewaysRequest
9889
10941
  * @param headers - map
@@ -9894,7 +10946,7 @@ export default class Client extends OpenApi {
9894
10946
  [key: string]: string;
9895
10947
  }, runtime: $dara.RuntimeOptions): Promise<ListGatewaysResponse>;
9896
10948
  /**
9897
- * Retrieve the list of created cloud-native gateways
10949
+ * Queries a list of instances.
9898
10950
  *
9899
10951
  * @param request - ListGatewaysRequest
9900
10952
  * @returns ListGatewaysResponse
@@ -9919,7 +10971,7 @@ export default class Client extends OpenApi {
9919
10971
  */
9920
10972
  listHttpApiOperations(httpApiId: string, request: ListHttpApiOperationsRequest): Promise<ListHttpApiOperationsResponse>;
9921
10973
  /**
9922
- * 创建HttpApi的路由
10974
+ * Queries the routes of an HTTP API.
9923
10975
  *
9924
10976
  * @param request - ListHttpApiRoutesRequest
9925
10977
  * @param headers - map
@@ -9930,14 +10982,14 @@ export default class Client extends OpenApi {
9930
10982
  [key: string]: string;
9931
10983
  }, runtime: $dara.RuntimeOptions): Promise<ListHttpApiRoutesResponse>;
9932
10984
  /**
9933
- * 创建HttpApi的路由
10985
+ * Queries the routes of an HTTP API.
9934
10986
  *
9935
10987
  * @param request - ListHttpApiRoutesRequest
9936
10988
  * @returns ListHttpApiRoutesResponse
9937
10989
  */
9938
10990
  listHttpApiRoutes(httpApiId: string, request: ListHttpApiRoutesRequest): Promise<ListHttpApiRoutesResponse>;
9939
10991
  /**
9940
- * List HTTP APIs
10992
+ * Queries a list of HTTP APIs.
9941
10993
  *
9942
10994
  * @param request - ListHttpApisRequest
9943
10995
  * @param headers - map
@@ -9948,14 +11000,14 @@ export default class Client extends OpenApi {
9948
11000
  [key: string]: string;
9949
11001
  }, runtime: $dara.RuntimeOptions): Promise<ListHttpApisResponse>;
9950
11002
  /**
9951
- * List HTTP APIs
11003
+ * Queries a list of HTTP APIs.
9952
11004
  *
9953
11005
  * @param request - ListHttpApisRequest
9954
11006
  * @returns ListHttpApisResponse
9955
11007
  */
9956
11008
  listHttpApis(request: ListHttpApisRequest): Promise<ListHttpApisResponse>;
9957
11009
  /**
9958
- * ListPolicyClasses。
11010
+ * ListPolicyClasses
9959
11011
  *
9960
11012
  * @param request - ListPolicyClassesRequest
9961
11013
  * @param headers - map
@@ -9966,14 +11018,14 @@ export default class Client extends OpenApi {
9966
11018
  [key: string]: string;
9967
11019
  }, runtime: $dara.RuntimeOptions): Promise<ListPolicyClassesResponse>;
9968
11020
  /**
9969
- * ListPolicyClasses。
11021
+ * ListPolicyClasses
9970
11022
  *
9971
11023
  * @param request - ListPolicyClassesRequest
9972
11024
  * @returns ListPolicyClassesResponse
9973
11025
  */
9974
11026
  listPolicyClasses(request: ListPolicyClassesRequest): Promise<ListPolicyClassesResponse>;
9975
11027
  /**
9976
- * 获取服务列表
11028
+ * Queries a list of services.
9977
11029
  *
9978
11030
  * @param request - ListServicesRequest
9979
11031
  * @param headers - map
@@ -9984,14 +11036,14 @@ export default class Client extends OpenApi {
9984
11036
  [key: string]: string;
9985
11037
  }, runtime: $dara.RuntimeOptions): Promise<ListServicesResponse>;
9986
11038
  /**
9987
- * 获取服务列表
11039
+ * Queries a list of services.
9988
11040
  *
9989
11041
  * @param request - ListServicesRequest
9990
11042
  * @returns ListServicesResponse
9991
11043
  */
9992
11044
  listServices(request: ListServicesRequest): Promise<ListServicesResponse>;
9993
11045
  /**
9994
- * ListSslCerts。
11046
+ * ListSslCerts
9995
11047
  *
9996
11048
  * @param request - ListSslCertsRequest
9997
11049
  * @param headers - map
@@ -10002,14 +11054,14 @@ export default class Client extends OpenApi {
10002
11054
  [key: string]: string;
10003
11055
  }, runtime: $dara.RuntimeOptions): Promise<ListSslCertsResponse>;
10004
11056
  /**
10005
- * ListSslCerts。
11057
+ * ListSslCerts
10006
11058
  *
10007
11059
  * @param request - ListSslCertsRequest
10008
11060
  * @returns ListSslCertsResponse
10009
11061
  */
10010
11062
  listSslCerts(request: ListSslCertsRequest): Promise<ListSslCertsResponse>;
10011
11063
  /**
10012
- * 获取云原生API网关region下的可用区
11064
+ * Retrieve the availability zones under a cloud-native API gateway region
10013
11065
  *
10014
11066
  * @param headers - map
10015
11067
  * @param runtime - runtime options for this request RuntimeOptions
@@ -10019,7 +11071,7 @@ export default class Client extends OpenApi {
10019
11071
  [key: string]: string;
10020
11072
  }, runtime: $dara.RuntimeOptions): Promise<ListZonesResponse>;
10021
11073
  /**
10022
- * 获取云原生API网关region下的可用区
11074
+ * Retrieve the availability zones under a cloud-native API gateway region
10023
11075
  * @returns ListZonesResponse
10024
11076
  */
10025
11077
  listZones(): Promise<ListZonesResponse>;
@@ -10039,7 +11091,25 @@ export default class Client extends OpenApi {
10039
11091
  */
10040
11092
  restartGateway(gatewayId: string): Promise<RestartGatewayResponse>;
10041
11093
  /**
10042
- * UpdateDomain
11094
+ * 取消部署HttpApi
11095
+ *
11096
+ * @param request - UndeployHttpApiRequest
11097
+ * @param headers - map
11098
+ * @param runtime - runtime options for this request RuntimeOptions
11099
+ * @returns UndeployHttpApiResponse
11100
+ */
11101
+ undeployHttpApiWithOptions(httpApiId: string, request: UndeployHttpApiRequest, headers: {
11102
+ [key: string]: string;
11103
+ }, runtime: $dara.RuntimeOptions): Promise<UndeployHttpApiResponse>;
11104
+ /**
11105
+ * 取消部署HttpApi
11106
+ *
11107
+ * @param request - UndeployHttpApiRequest
11108
+ * @returns UndeployHttpApiResponse
11109
+ */
11110
+ undeployHttpApi(httpApiId: string, request: UndeployHttpApiRequest): Promise<UndeployHttpApiResponse>;
11111
+ /**
11112
+ * Updates a domain name.
10043
11113
  *
10044
11114
  * @param request - UpdateDomainRequest
10045
11115
  * @param headers - map
@@ -10050,7 +11120,7 @@ export default class Client extends OpenApi {
10050
11120
  [key: string]: string;
10051
11121
  }, runtime: $dara.RuntimeOptions): Promise<UpdateDomainResponse>;
10052
11122
  /**
10053
- * UpdateDomain
11123
+ * Updates a domain name.
10054
11124
  *
10055
11125
  * @param request - UpdateDomainRequest
10056
11126
  * @returns UpdateDomainResponse
@@ -10115,7 +11185,7 @@ export default class Client extends OpenApi {
10115
11185
  */
10116
11186
  updateGatewayName(gatewayId: string, request: UpdateGatewayNameRequest): Promise<UpdateGatewayNameResponse>;
10117
11187
  /**
10118
- * Update HTTP API
11188
+ * Updates an HTTP API.
10119
11189
  *
10120
11190
  * @param request - UpdateHttpApiRequest
10121
11191
  * @param headers - map
@@ -10126,7 +11196,7 @@ export default class Client extends OpenApi {
10126
11196
  [key: string]: string;
10127
11197
  }, runtime: $dara.RuntimeOptions): Promise<UpdateHttpApiResponse>;
10128
11198
  /**
10129
- * Update HTTP API
11199
+ * Updates an HTTP API.
10130
11200
  *
10131
11201
  * @param request - UpdateHttpApiRequest
10132
11202
  * @returns UpdateHttpApiResponse
@@ -10151,7 +11221,7 @@ export default class Client extends OpenApi {
10151
11221
  */
10152
11222
  updateHttpApiOperation(httpApiId: string, operationId: string, request: UpdateHttpApiOperationRequest): Promise<UpdateHttpApiOperationResponse>;
10153
11223
  /**
10154
- * Update the route of HttpApi
11224
+ * Updates the route of an HTTP API.
10155
11225
  *
10156
11226
  * @param request - UpdateHttpApiRouteRequest
10157
11227
  * @param headers - map
@@ -10162,14 +11232,14 @@ export default class Client extends OpenApi {
10162
11232
  [key: string]: string;
10163
11233
  }, runtime: $dara.RuntimeOptions): Promise<UpdateHttpApiRouteResponse>;
10164
11234
  /**
10165
- * Update the route of HttpApi
11235
+ * Updates the route of an HTTP API.
10166
11236
  *
10167
11237
  * @param request - UpdateHttpApiRouteRequest
10168
11238
  * @returns UpdateHttpApiRouteResponse
10169
11239
  */
10170
11240
  updateHttpApiRoute(httpApiId: string, routeId: string, request: UpdateHttpApiRouteRequest): Promise<UpdateHttpApiRouteResponse>;
10171
11241
  /**
10172
- * 更新策略
11242
+ * Update Policy
10173
11243
  *
10174
11244
  * @param request - UpdatePolicyRequest
10175
11245
  * @param headers - map
@@ -10180,7 +11250,7 @@ export default class Client extends OpenApi {
10180
11250
  [key: string]: string;
10181
11251
  }, runtime: $dara.RuntimeOptions): Promise<UpdatePolicyResponse>;
10182
11252
  /**
10183
- * 更新策略
11253
+ * Update Policy
10184
11254
  *
10185
11255
  * @param request - UpdatePolicyRequest
10186
11256
  * @returns UpdatePolicyResponse