From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/mse/2019-05-31/api-docs.php | 82033 +++++++++++-------------------- 1 file changed, 28146 insertions(+), 53887 deletions(-) (limited to 'data/en_us/mse') diff --git a/data/en_us/mse/2019-05-31/api-docs.php b/data/en_us/mse/2019-05-31/api-docs.php index 6e45654..eab0253 100644 --- a/data/en_us/mse/2019-05-31/api-docs.php +++ b/data/en_us/mse/2019-05-31/api-docs.php @@ -1,513 +1,190 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'mse', - 'version' => '2019-05-31', - ], + 'info' => ['style' => 'RPC', 'product' => 'mse', 'version' => '2019-05-31'], 'directories' => [ [ - 'id' => 365620, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'UntagResources', - 'TagResources', - ], - ], - [ - 'id' => 365624, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 365625, - 'title' => null, + 'children' => ['UpdateMigrationTask', 'AddMigrationTask', 'ListMigrationTask', 'DeleteMigrationTask'], 'type' => 'directory', - 'children' => [ - 'UpdateMigrationTask', - 'AddMigrationTask', - 'ListMigrationTask', - 'DeleteMigrationTask', - ], + 'title' => 'Workload migration', ], [ - 'id' => 365630, - 'title' => null, + 'children' => ['PutClusterHealthCheckTask', 'OrderClusterHealthCheckRiskNotice', 'ListClusterHealthCheckTask'], 'type' => 'directory', - 'children' => [ - 'PutClusterHealthCheckTask', - 'OrderClusterHealthCheckRiskNotice', - 'ListClusterHealthCheckTask', - ], + 'title' => 'Risk assessment', ], [ - 'id' => 365634, - 'title' => null, + 'children' => ['ListConfigTrack', 'CreateNacosConfig', 'DeleteNacosConfig', 'UpdateNacosConfig', 'ListListenersByConfig', 'ListListenersByIp', 'GetNacosConfig', 'GetNacosHistoryConfig', 'ListNacosConfigs', 'ListNacosHistoryConfigs', 'CloneNacosConfig', 'ExportNacosConfig', 'GetImportFileUrl', 'ImportNacosConfig'], 'type' => 'directory', - 'children' => [ - 'ListConfigTrack', - 'CreateNacosConfig', - 'DeleteNacosConfig', - 'DeleteNacosConfigs', - 'UpdateNacosConfig', - 'ListListenersByConfig', - 'ListListenersByIp', - 'GetNacosConfig', - 'GetNacosHistoryConfig', - 'ListNacosConfigs', - 'ListNacosHistoryConfigs', - 'CloneNacosConfig', - 'ExportNacosConfig', - 'GetImportFileUrl', - 'ImportNacosConfig', - ], - ], - [ - 'id' => 365650, - 'title' => null, + 'title' => 'Nacos configuration', + ], + [ + 'children' => ['ListNamingTrack', 'ListAnsServices', 'DeleteNacosService', 'UpdateNacosCluster', 'ListAnsServiceClusters', 'CreateNacosInstance', 'DeleteNacosInstance', 'UpdateNacosInstance', 'ListAnsInstances'], 'type' => 'directory', - 'children' => [ - 'ListNamingTrack', - 'CreateNacosService', - 'ListAnsServices', - 'DeleteNacosService', - 'UpdateNacosService', - 'UpdateNacosCluster', - 'ListAnsServiceClusters', - 'CreateNacosInstance', - 'DeleteNacosInstance', - 'UpdateNacosInstance', - 'ListAnsInstances', - 'GetServiceListeners', - ], - ], - [ - 'id' => 365663, - 'title' => null, + 'title' => 'Nacos service', + ], + [ + 'children' => ['ListEurekaServices', 'ListEurekaInstances'], 'type' => 'directory', - 'children' => [ - 'ListEurekaServices', - 'ListEurekaInstances', - ], + 'title' => 'Eureka service', ], [ - 'id' => 365666, - 'title' => null, + 'children' => ['QueryMonitor'], 'type' => 'directory', - 'children' => [ - 'QueryMonitor', - ], + 'title' => 'Monitoring management', ], [ - 'id' => 365668, - 'title' => null, + 'children' => ['UpdateAcl'], 'type' => 'directory', - 'children' => [ - 'UpdateAcl', - ], + 'title' => 'Public access whitelist management', ], [ - 'id' => 365670, - 'title' => null, + 'children' => ['QueryInstancesInfo', 'QueryClusterInfo', 'QueryClusterDetail', 'UpdateCluster', 'ListClusterTypes', 'ListClusterVersions', 'QueryClusterSpecification', 'QueryClusterDiskSpecification', 'ListInstanceCount', 'QueryConfig', 'GetMseFeatureSwitch', 'QueryBusinessLocations', 'QuerySlbSpec', 'UpdateClusterSpec', 'RestartCluster', 'RetryCluster'], 'type' => 'directory', - 'children' => [ - 'QueryInstancesInfo', - 'QueryClusterInfo', - 'QueryClusterDetail', - 'CreateCluster', - 'DeleteCluster', - 'UpdateCluster', - 'UpdateConfig', - 'ListClusters', - 'ListClusterTypes', - 'ListClusterVersions', - 'QueryClusterSpecification', - 'QueryClusterDiskSpecification', - 'ListInstanceCount', - 'QueryConfig', - 'GetImage', - 'UpdateImage', - 'GetMseFeatureSwitch', - 'QueryBusinessLocations', - 'ListClusterConnectionTypes', - 'QuerySlbSpec', - 'UpdateClusterSpec', - 'RestartCluster', - 'RetryCluster', - 'UpgradeCluster', - ], - ], - [ - 'id' => 365695, - 'title' => null, + 'title' => 'Cluster management', + ], + [ + 'children' => ['CreateEngineNamespace', 'DeleteEngineNamespace', 'UpdateEngineNamespace', 'ListEngineNamespaces'], 'type' => 'directory', - 'children' => [ - 'CreateEngineNamespace', - 'DeleteEngineNamespace', - 'UpdateEngineNamespace', - 'GetEngineNamepace', - 'ListEngineNamespaces', - ], + 'title' => 'Namespace', ], [ - 'id' => 365701, - 'title' => null, + 'children' => ['ImportZookeeperData', 'GetZookeeperDataImportUrl', 'ExportZookeeperData', 'ListExportZookeeperData', 'CreateZnode', 'DeleteZnode', 'UpdateZnode', 'ListZnodeChildren', 'QueryZnodeDetail'], 'type' => 'directory', - 'children' => [ - 'ImportZookeeperData', - 'GetZookeeperDataImportUrl', - 'ExportZookeeperData', - 'ListExportZookeeperData', - 'CreateZnode', - 'DeleteZnode', - 'UpdateZnode', - 'ListZnodeChildren', - 'QueryZnodeDetail', - 'ListZkTrack', - ], + 'title' => 'ZooKeeper data node', ], ], + 'type' => 'directory', + 'title' => 'Registration and configuration center', ], [ - 'id' => 365712, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 365713, - 'title' => null, + 'children' => ['ListIsolationRules', 'CreateIsolationRule', 'DeleteIsolationRules', 'UpdateIsolationRule', 'UpdateFlowRule', 'ListFlowRules', 'CreateFlowRule', 'ListCircuitBreakerRules', 'ListWebFlowRules', 'CreateWebFlowRule', 'DeleteWebFlowRules', 'UpdateWebFlowRule'], 'type' => 'directory', - 'children' => [ - 'ListSentinelBlockFallbackDefinitions', - 'BindSentinelBlockFallbackDefinition', - 'ListIsolationRules', - 'CreateIsolationRule', - 'DeleteIsolationRules', - 'UpdateIsolationRule', - 'DeleteCircuitBreakerRules', - 'DeleteFlowRules', - 'UpdateFlowRule', - 'ListFlowRules', - 'CreateFlowRule', - 'CreateCircuitBreakerRule', - 'ListCircuitBreakerRules', - 'UpdateCircuitBreakerRule', - 'ListWebFlowRules', - 'CreateWebFlowRule', - 'DeleteWebFlowRules', - 'UpdateWebFlowRule', - ], - ], - [ - 'id' => 365732, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListAuthPolicy', - 'UpdateAuthPolicy', - 'AddAuthPolicy', - 'RemoveAuthPolicy', - ], + 'title' => 'Throttling protection', ], [ - 'id' => 365737, - 'title' => null, + 'children' => ['ListAuthPolicy', 'UpdateAuthPolicy', 'AddAuthPolicy', 'RemoveAuthPolicy'], 'type' => 'directory', - 'children' => [ - 'GetServiceMethodPage', - 'GetServiceListPage', - 'GetServiceList', - ], + 'title' => 'Service authentication', ], [ - 'id' => 365741, - 'title' => null, + 'children' => ['GetServiceMethodPage', 'GetServiceListPage'], 'type' => 'directory', - 'children' => [ - 'CreateOrUpdateSwimmingLaneGroup', - 'DeleteSwimmingLaneGroup', - 'CreateOrUpdateSwimmingLane', - 'DeleteSwimmingLane', - 'QueryAllSwimmingLaneGroup', - 'QueryAllSwimmingLane', - 'GetTagsBySwimmingLaneGroupId', - 'QuerySwimmingLaneById', - 'ListAppBySwimmingLaneGroupTags', - 'ListAppBySwimmingLaneGroupTag', - ], + 'title' => 'Service query', ], [ - 'id' => 365752, - 'title' => null, + 'children' => ['CreateOrUpdateSwimmingLaneGroup', 'DeleteSwimmingLaneGroup', 'CreateOrUpdateSwimmingLane', 'DeleteSwimmingLane', 'QueryAllSwimmingLaneGroup', 'QueryAllSwimmingLane', 'GetTagsBySwimmingLaneGroupId', 'QuerySwimmingLaneById', 'ListAppBySwimmingLaneGroupTag'], 'type' => 'directory', - 'children' => [ - 'GetLosslessRuleByApp', - 'ModifyLosslessRule', - 'FetchLosslessRuleList', - ], + 'title' => 'End-to-end canary release', ], [ - 'id' => 365756, - 'title' => null, + 'children' => ['FetchLosslessRuleList'], 'type' => 'directory', - 'children' => [ - 'GetLocalityRule', - 'UpdateLocalityRule', - ], + 'title' => 'Graceful start and shutdown', ], [ - 'id' => 365759, - 'title' => null, + 'children' => ['GetLocalityRule', 'UpdateLocalityRule'], 'type' => 'directory', - 'children' => [ - 'GetApplicationList', - 'CreateMseServiceApplication', - 'CreateApplication', - 'GetOverview', - 'RemoveApplication', - 'GetApplicationInstanceList', - ], + 'title' => 'Zone affinity', ], [ - 'id' => 365766, - 'title' => null, + 'children' => ['GetApplicationList', 'CreateMseServiceApplication', 'RemoveApplication'], 'type' => 'directory', + 'title' => 'Application governance', + ], + [ 'children' => [ [ - 'id' => 365767, - 'title' => null, + 'children' => ['QueryGovernanceKubernetesCluster', 'ModifyGovernanceKubernetesCluster', 'GetGovernanceKubernetesCluster'], 'type' => 'directory', - 'children' => [ - 'QueryGovernanceKubernetesCluster', - 'ModifyGovernanceKubernetesCluster', - 'GetGovernanceKubernetesCluster', - ], + 'title' => 'K8s cluster management', ], [ - 'id' => 365771, - 'title' => null, + 'children' => ['QueryNamespace'], 'type' => 'directory', - 'children' => [ - 'ListNamespaces', - 'CreateNamespace', - 'DeleteNamespace', - 'QueryNamespace', - ], + 'title' => 'Microservice namespace management', ], ], + 'type' => 'directory', + 'title' => 'O&M center', ], [ - 'id' => 365776, - 'title' => null, + 'children' => ['ApplyTagPolicies', 'ListApplicationsWithTagRules'], 'type' => 'directory', - 'children' => [ - 'ApplyTagPolicies', - 'ListApplicationsWithTagRules', - ], + 'title' => 'Tag-based routing', ], [ - 'id' => 365779, - 'title' => null, + 'children' => ['UpdateMessageQueueRoute'], 'type' => 'directory', - 'children' => [ - 'GetAppMessageQueueRoute', - 'UpdateMessageQueueRoute', - ], + 'title' => 'Message canary release', ], [ - 'id' => 365782, - 'title' => null, + 'children' => ['AddMockRule'], 'type' => 'directory', - 'children' => [ - 'AddMockRule', - ], + 'title' => 'Mock rules', ], ], + 'type' => 'directory', + 'title' => 'Microservice governance center', ], [ - 'id' => 365784, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 365785, - 'title' => null, + 'children' => ['GetPlugins', 'GetPluginConfig', 'CreatePluginConfig', 'UpdatePluginConfig'], 'type' => 'directory', - 'children' => [ - 'GetPlugins', - 'GetPluginConfig', - 'CreatePluginConfig', - 'UpdatePluginConfig', - 'DeletePluginConfig', - ], + 'title' => 'Plugin marketplace', ], [ - 'id' => 365791, - 'title' => null, + 'children' => ['AddGatewayDomain', 'UpdateSSLCert', 'UpdateGatewayDomain', 'ListSSLCert', 'ListGatewayDomain', 'GetGatewayDomainDetail'], 'type' => 'directory', - 'children' => [ - 'AddSSLCert', - 'AddGatewayDomain', - 'DeleteGatewayDomain', - 'UpdateSSLCert', - 'UpdateGatewayDomain', - 'ListSSLCert', - 'ListGatewayDomain', - 'GetGatewayDomainDetail', - ], + 'title' => 'Domain certificate', ], [ - 'id' => 365800, - 'title' => null, + 'children' => ['AddGateway', 'ListGatewayZone', 'AddGatewaySlb', 'DeleteGatewaySlb', 'DeleteSecurityGroupRule', 'UpdateGatewayOption', 'QueryGatewayRegion', 'QueryGatewayType', 'ListGatewaySlb', 'GetGatewayOption', 'ListSecurityGroupRule', 'UpdateGatewaySpec', 'SelectGatewaySlb'], 'type' => 'directory', - 'children' => [ - 'AddGateway', - 'ListGatewayZone', - 'AddGatewaySlb', - 'AddSecurityGroupRule', - 'DeleteGateway', - 'DeleteGatewaySlb', - 'DeleteSecurityGroupRule', - 'UpdateGatewayOption', - 'UpdateGatewayName', - 'QueryGatewayRegion', - 'QueryGatewayType', - 'GetGateway', - 'ListGateway', - 'ListGatewaySlb', - 'GetGatewayOption', - 'ListSecurityGroupRule', - 'ListSecurityGroup', - 'UpdateGatewaySpec', - 'SelectGatewaySlb', - ], - ], - [ - 'id' => 365820, - 'title' => null, + 'title' => 'Gateway management', + ], + [ + 'children' => ['AddGatewayServiceVersion', 'DeleteGatewayServiceVersion', 'UpdateGatewayServiceTrafficPolicy', 'UpdateGatewayServiceVersion', 'ListServiceSource', 'ListGatewayService', 'GetMseSource', 'GetGatewayServiceDetail', 'ImportServices', 'UpdateGatewayService', 'PullServices'], 'type' => 'directory', - 'children' => [ - 'AddServiceSource', - 'AddGatewayServiceVersion', - 'DeleteServiceSource', - 'DeleteGatewayServiceVersion', - 'DeleteGatewayService', - 'UpdateGatewayServiceTrafficPolicy', - 'UpdateGatewayServiceVersion', - 'ListServiceSource', - 'ListGatewayService', - 'GetMseSource', - 'GetKubernetesSource', - 'GetGatewayServiceDetail', - 'UpdateServiceSource', - 'ImportServices', - 'UpdateGatewayService', - 'PullServices', - 'UpdateGatewayServiceCheck', - ], - ], - [ - 'id' => 365838, - 'title' => null, + 'title' => 'Service management', + ], + [ + 'children' => ['UpdateGatewayRouteAuth', 'ListGatewayAuthConsumerResource', 'UpdateGatewayAuthConsumer', 'ListGatewayRouteOnAuth', 'ListGatewayAuthConsumer', 'UpdateGatewayAuthConsumerResource', 'UpdateGatewayAuthConsumerStatus', 'AddGatewayAuthConsumer', 'DeleteGatewayAuthConsumerResource', 'UpdateGatewayAuthConsumerResourceStatus', 'DeleteGatewayAuthConsumer', 'GetGatewayAuthConsumerDetail', 'GatewayBlackWhiteList', 'AddGatewayAuth', 'GetGatewayAuthDetail', 'DeleteAuthResource'], 'type' => 'directory', - 'children' => [ - 'UpdateGatewayRouteAuth', - 'ListGatewayAuthConsumerResource', - 'UpdateGatewayAuthConsumer', - 'ListGatewayRouteOnAuth', - 'ListGatewayAuthConsumer', - 'UpdateGatewayAuthConsumerResource', - 'UpdateGatewayAuthConsumerStatus', - 'AddGatewayAuthConsumer', - 'DeleteGatewayAuthConsumerResource', - 'UpdateGatewayAuthConsumerResourceStatus', - 'DeleteGatewayAuthConsumer', - 'GetGatewayAuthConsumerDetail', - 'AddBlackWhiteList', - 'UpdateBlackWhiteList', - 'GatewayBlackWhiteList', - 'DeleteBlackWhiteList', - 'GetBlackWhiteList', - 'AddGatewayAuth', - 'UpdateGatewayAuth', - 'GetGatewayAuthDetail', - 'ListGatewayAuth', - 'DeleteGatewayAuth', - 'AddAuthResource', - 'DeleteAuthResource', - ], - ], - [ - 'id' => 365863, - 'title' => null, + 'title' => 'Security capabilities', + ], + [ + 'children' => ['AddGatewayRoute', 'DeleteGatewayRoute', 'UpdateGatewayRouteHTTPRewrite', 'UpdateGatewayRoute', 'UpdateGatewayRouteCORS', 'UpdateGatewayRouteRetry', 'GetGatewayRouteDetail', 'ListGatewayRoute', 'OfflineGatewayRoute'], 'type' => 'directory', - 'children' => [ - 'AddGatewayRoute', - 'DeleteGatewayRoute', - 'UpdateGatewayRouteHTTPRewrite', - 'UpdateGatewayRoute', - 'UpdateGatewayRouteCORS', - 'UpdateGatewayRouteHeaderOp', - 'UpdateGatewayRouteTimeout', - 'UpdateGatewayRouteRetry', - 'GetGatewayRouteDetail', - 'ListGatewayRoute', - 'UpdateGatewayRouteWafStatus', - 'ApplyGatewayRoute', - 'OfflineGatewayRoute', - ], - ], - [ - 'id' => 365877, - 'title' => null, + 'title' => 'Route configuration', + ], + [ + 'children' => ['GetGatewayConfig'], 'type' => 'directory', - 'children' => [ - 'GetGatewayConfig', - 'EnableProxyProtocol', - 'EnableHttp2', - 'PreserveHeaderFormat', - ], + 'title' => 'Parameter configuration', ], [ - 'id' => 365882, - 'title' => null, + 'children' => ['DeleteGatewayFlowRule', 'UpdateGatewayFlowRule', 'ListGatewayFlowRule', 'CreateGatewayCircuitBreakerRule', 'DeleteGatewayCircuitBreakerRule', 'UpdateGatewayCircuitBreakerRule', 'ListGatewayCircuitBreakerRule', 'CreateGatewayIsolationRule', 'DeleteGatewayIsolationRule', 'UpdateGatewayIsolationRule', 'ListGatewayIsolationRule'], 'type' => 'directory', - 'children' => [ - 'CreateGatewayFlowRule', - 'DeleteGatewayFlowRule', - 'UpdateGatewayFlowRule', - 'ListGatewayFlowRule', - 'CreateGatewayCircuitBreakerRule', - 'DeleteGatewayCircuitBreakerRule', - 'UpdateGatewayCircuitBreakerRule', - 'ListGatewayCircuitBreakerRule', - 'CreateGatewayIsolationRule', - 'DeleteGatewayIsolationRule', - 'UpdateGatewayIsolationRule', - 'ListGatewayIsolationRule', - ], + 'title' => 'Policy configuration', ], ], + 'type' => 'directory', + 'title' => 'Cloud-native gateway', ], [ - 'id' => 365895, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'InitializeServiceLinkRole', - 'CloneSentinelRuleFromAhas', - 'ChangeResourceGroup', - 'UpdateNacosGrayConfig', - 'UpdateGatewayConfig', - 'CreateSentinelBlockFallbackDefinition', - 'CreateNacosMcpServer', - 'DeleteNacosMcpServer', - 'GetNacosMcpServer', - 'ListNacosMcpServers', - 'QueryNacosGrayConfig', + 'InitializeServiceLinkRole', 'UpdateNacosGrayConfig', 'UpdateGatewayConfig', 'CreateSentinelBlockFallbackDefinition', 'AddAuthResource', 'AddBlackWhiteList', 'AddSSLCert', 'AddSecurityGroupRule', 'AddServiceSource', 'AddZooKeeperSaslUser', 'ApplyGatewayRoute', 'BindSentinelBlockFallbackDefinition', 'ChangeResourceGroup', 'CloneSentinelRuleFromAhas', 'CreateApplication', 'CreateCircuitBreakerRule', 'CreateCluster', 'CreateGatewayFlowRule', 'CreateNacosService', 'CreateNamespace', + 'DeleteCircuitBreakerRules', 'DeleteCluster', 'DeleteFlowRules', 'DeleteGateway', 'DeleteGatewayDomain', 'DeleteGatewayService', 'DeleteNacosConfigs', 'DeleteNamespace', 'DeletePluginConfig', 'DeleteServiceSource', 'EnableHttp2', 'EnableProxyProtocol', 'GetAppMessageQueueRoute', 'GetApplicationInstanceList', 'GetBlackWhiteList', 'GetEngineNamepace', 'GetGateway', 'GetImage', 'GetKubernetesSource', 'GetLosslessRuleByApp', + 'GetOverview', 'GetServiceList', 'GetServiceListeners', 'ListAppBySwimmingLaneGroupTags', 'ListClusterConnectionTypes', 'ListClusters', 'ListGateway', 'ListNamespaces', 'ListSecurityGroup', 'ListSentinelBlockFallbackDefinitions', 'ListTagResources', 'ListZkTrack', 'ListZooKeeperSaslUser', 'ModifyLosslessRule', 'PreserveHeaderFormat', 'RemoveZooKeeperSaslUser', 'TagResources', 'UntagResources', 'UpdateBlackWhiteList', 'UpdateCircuitBreakerRule', + 'UpdateConfig', 'UpdateGatewayName', 'UpdateGatewayRouteHeaderOp', 'UpdateGatewayRouteTimeout', 'UpdateGatewayRouteWafStatus', 'UpdateGatewayServiceCheck', 'UpdateImage', 'UpdateNacosService', 'UpdateServiceSource', 'UpdateZooKeeperSaslUser', 'UpgradeCluster', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ @@ -515,107 +192,35 @@ 'GatewayDomain' => [ 'title' => 'A short description of struct', 'description' => 'The data structure.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'Domain Id', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => 'Domain Name', - 'description' => 'The domain name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test.com', - 'backendName' => 'name', - ], - 'Protocol' => [ - 'title' => '', - 'description' => 'The domain protocol.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'HTTPS', - 'backendName' => 'protocol', - ], - 'MustHttps' => [ - 'title' => '', - 'description' => 'Indicates whether HTTPS is forcibly used.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'mustHttps', - ], - 'CertIdentifier' => [ - 'title' => '', - 'description' => 'The ID of the certificate in use.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '595xx36-cn-hangzhou', - 'backendName' => 'certIdentifier', - ], - 'GatewayId' => [ - 'title' => '', - 'description' => 'The gateway ID.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'gatewayId', - ], - 'GatewayUniqueId' => [ - 'title' => '', - 'description' => 'The unique ID of the gateway.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - 'backendName' => 'gatewayUniqueId', - ], - 'GmtCreate' => [ - 'title' => '', - 'description' => 'The time when the gateway was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-07-31 10:16:46', - 'backendName' => 'gmtCreate', - ], - 'GmtModified' => [ - 'title' => '', - 'description' => 'The time when the gateway was modified.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-08-11 15:28:47', - 'backendName' => 'gmtModified', - ], - 'GatewayName' => [ - 'title' => '', - 'description' => 'The name of the gateway.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'gatewayName', - ], + 'Id' => ['title' => 'Domain Id', 'description' => 'The domain ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'backendName' => 'id'], + 'Name' => ['title' => 'Domain Name', 'description' => 'The domain name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test.com', 'backendName' => 'name'], + 'Protocol' => ['title' => 'domainn的协议', 'description' => 'The domain protocol.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'HTTPS', 'backendName' => 'protocol'], + 'MustHttps' => ['title' => '是否强制跳转', 'description' => 'Indicates whether HTTPS is forcibly used.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true', 'backendName' => 'mustHttps'], + 'CertIdentifier' => ['title' => '使用的证书Id', 'description' => 'The ID of the certificate in use.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '595xx36-cn-hangzhou', 'backendName' => 'certIdentifier'], + 'GatewayId' => ['title' => '网关ID', 'description' => 'The gateway ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'gatewayId'], + 'GatewayUniqueId' => ['title' => '网关唯一标识', 'description' => 'The unique ID of the gateway.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'backendName' => 'gatewayUniqueId'], + 'GmtCreate' => ['title' => '创建时间', 'description' => 'The time when the gateway was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-07-31 10:16:46', 'backendName' => 'gmtCreate'], + 'GmtModified' => ['title' => '修改时间', 'description' => 'The time when the gateway was modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-08-11 15:28:47', 'backendName' => 'gmtModified'], + 'GatewayName' => ['title' => '网关名称', 'description' => 'The name of the gateway.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'gatewayName'], ], ], 'GatewayOption' => [ 'title' => 'A short description of struct', 'description' => 'The detailed configurations of the gateway.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TraceDetails' => [ 'title' => 'xtrace config option', 'description' => 'The data structure.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TraceEnabled' => [ - 'title' => '', + 'title' => 'trace是否开启', 'description' => 'Specifies whether to activate Tracing Analysis.'."\n" ."\n" .'Valid value:'."\n" @@ -635,20 +240,17 @@ .' '."\n" ."\n" .' '."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, - 'enumValueTitles' => [ - 'false' => '', - 'true' => '', - ], + 'enumValueTitles' => ['false' => '关闭xtrace', 'true' => '开启xtrace'], 'example' => 'true', 'backendName' => 'traceOn', ], 'Sample' => [ - 'title' => '', + 'title' => 'trace采样率，默认为10', 'description' => 'The sampling rate of Tracing Analysis.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [], @@ -656,43 +258,20 @@ 'backendName' => 'sample', 'default' => '10', ], - 'TraceType' => [ - 'title' => '', - 'description' => 'The type of Tracing Analysis. Valid values: XTRACE and SKYWALKING.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'XTRACE', - 'backendName' => 'traceType', - 'default' => 'XTRACE', - ], - 'ServiceId' => [ - 'title' => '', - 'description' => 'The ID of the SkyWalking service. This parameter is required if TraceType is set to SKYWALKING.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10458', - 'backendName' => 'serviceId', - ], - 'ServicePort' => [ - 'title' => '', - 'description' => 'The port of the SkyWalking service. This parameter is required if TraceType is set to SKYWALKING.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '80', - 'backendName' => 'servicePort', - ], + 'TraceType' => ['title' => 'trace类型，可选XTRACE和SKYWALKING', 'description' => 'The type of Tracing Analysis. Valid values: XTRACE and SKYWALKING.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'XTRACE', 'backendName' => 'traceType', 'default' => 'XTRACE'], + 'ServiceId' => ['title' => 'SkyWalking服务Id，trace类型为SKYWALKING时必填', 'description' => 'The ID of the SkyWalking service. This parameter is required if TraceType is set to SKYWALKING.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10458', 'backendName' => 'serviceId'], + 'ServicePort' => ['title' => 'SkyWalking服务端口，trace类型为SKYWALKING时必填', 'description' => 'The port of the SkyWalking service. This parameter is required if TraceType is set to SKYWALKING.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '80', 'backendName' => 'servicePort'], ], 'backendName' => 'xtraceDetails', ], 'LogConfigDetails' => [ - 'title' => '', + 'title' => '日志配置详情', 'description' => 'The description of Simple Log Service.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'LogEnabled' => [ - 'title' => '', + 'title' => '是否开启日志投递', 'description' => 'Specifies whether to activate Simple Log Service.'."\n" ."\n" .'Valid value:'."\n" @@ -712,243 +291,107 @@ .' '."\n" ."\n" .' '."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], + 'enumValueTitles' => ['true' => '开启日志投递', 'false' => '关闭日志投递'], 'example' => 'true', 'backendName' => 'logOn', ], - 'ProjectName' => [ - 'title' => '', - 'description' => 'The name of the destination Simple Log Service project.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'project', - 'backendName' => 'projectName', - ], - 'LogStoreName' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - 'backendName' => 'logStoreName', - ], + 'ProjectName' => ['title' => '投递的目标project', 'description' => 'The name of the destination Simple Log Service project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'project', 'backendName' => 'projectName'], + 'LogStoreName' => ['title' => '投递的目标logstore', 'description' => 'The name of the Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'name', 'backendName' => 'logStoreName'], ], 'backendName' => 'slsConfigDetails', ], - 'EnableHardwareAcceleration' => [ - 'title' => '', - 'description' => 'Specifies whether to enable hardware acceleration.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableHardwareAcceleration', - ], - 'DisableHttp2Alpn' => [ - 'title' => '', - 'description' => 'Specifies whether to disable the HTTP/2 protocol.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'disableHttp2Alpn', - ], - 'EnableWaf' => [ - 'title' => '', - 'description' => 'Specifies whether to enable Web Application Firewall (WAF).'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableWaf', - ], + 'EnableHardwareAcceleration' => ['title' => '是否开启硬件加速', 'description' => 'Specifies whether to enable hardware acceleration.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enableHardwareAcceleration'], + 'DisableHttp2Alpn' => ['title' => '是否禁用http', 'description' => 'Specifies whether to disable the HTTP/2 protocol.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'disableHttp2Alpn'], + 'EnableWaf' => ['title' => '是否开启waf', 'description' => 'Specifies whether to enable Web Application Firewall (WAF).'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enableWaf'], ], ], 'GatewayService' => [ 'title' => 'A short description of struct', 'description' => 'The information about the gateway service.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the service.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'name', - ], - 'SourceType' => [ - 'title' => '', - 'description' => 'The source type of the service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'sourceType', - ], - 'GatewayTrafficPolicy' => [ - 'title' => '', - 'description' => 'The traffic policy of the service.'."\n", - 'visibility' => 'public', - 'backendName' => 'gatewayTrafficPolicy', - '$ref' => '#/components/schemas/TrafficPolicy', - ], - 'GatewayUniqueId' => [ - 'title' => '', - 'description' => 'The unique ID of the gateway.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'gatewayUniqueId', - ], - 'MetaInfo' => [ - 'title' => '', - 'description' => 'The metadata of the service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'metaInfo', - ], - 'Namespace' => [ - 'title' => '', - 'description' => 'The namespace to which the service belongs.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'namespace', - ], - 'GroupName' => [ - 'title' => '', - 'description' => 'The name of the group to which the service belongs.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'groupName', - ], + 'Id' => ['title' => '服务id', 'description' => 'The ID of the service.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'id', 'example' => '1'], + 'Name' => ['title' => '服务名', 'description' => 'The name of the service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'test'], + 'SourceType' => ['title' => '服务来源', 'description' => 'The source type of the service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'sourceType', 'example' => 'MSE'], + 'GatewayTrafficPolicy' => ['title' => '服务的策略', 'description' => 'The traffic policy of the service.'."\n", 'visibility' => 'Public', 'backendName' => 'gatewayTrafficPolicy', '$ref' => '#/components/schemas/TrafficPolicy'], + 'GatewayUniqueId' => ['title' => '网关uniqueId', 'description' => 'The unique ID of the gateway.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gatewayUniqueId', 'example' => 'gw-913a49bab6c5461187a3305fb8da****'], + 'MetaInfo' => ['title' => '元信息', 'description' => 'The metadata of the service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'metaInfo', 'example' => '[\\"192.168.0.xxx:80\\"]'], + 'Namespace' => ['title' => '服务所属namesapce', 'description' => 'The namespace to which the service belongs.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'namespace', 'example' => 'public'], + 'GroupName' => ['title' => '服务所属group', 'description' => 'The name of the group to which the service belongs.'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'groupName', 'example' => 'DEFAULT_GROUP'], ], ], 'TrafficPolicy' => [ 'title' => 'A short description of struct', 'description' => 'The service traffic management.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TlsSetting' => [ - 'title' => '', + 'title' => 'tls相关配置', 'description' => 'The data structure.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TlsMode' => [ - 'title' => '', + 'title' => 'tls模式。为枚举类，可为NONE, SIMPLE, MUITUAL', 'description' => 'The Transport Layer Security (TLS) mode that is used to distribute traffic to backend services. Valid values:'."\n" ."\n" .'* DISABLE: TLS is disabled. Plaintext is used.'."\n" .'* SIMPLE: TLS is enabled.'."\n" .'* MUTUAL: Mutual Transport Layer Security (mTLS) is enabled.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'SIMPLE', 'backendName' => 'mode', ], - 'CertId' => [ - 'title' => '', - 'description' => 'The ID of the certificate that is managed in Alibaba Cloud Security.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '6456988-cn-hangzhou', - 'backendName' => 'certId', - ], - 'CaCertContent' => [ - 'title' => '', - 'description' => 'The trusted CA certificate chain. In mTLS, if the backend service certificate is issued by a private certificate authority (CA), you must add its CA certificate to the trusted CA certificate chain.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----', - 'backendName' => 'caCertContent', - ], - 'Sni' => [ - 'title' => '', - 'description' => 'The server name indication (SNI) that is used to establish TLS links.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'www.aliyun.com', - 'backendName' => 'sni', - ], + 'CertId' => ['title' => '使用的证书id，仅当为mutual时需要填写', 'description' => 'The ID of the certificate that is managed in Alibaba Cloud Security.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '6456988-cn-hangzhou', 'backendName' => 'certId'], + 'CaCertContent' => ['title' => 'ca证书内容', 'description' => 'The trusted CA certificate chain. In mTLS, if the backend service certificate is issued by a private certificate authority (CA), you must add its CA certificate to the trusted CA certificate chain.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----', 'backendName' => 'caCertContent'], + 'Sni' => ['title' => '到后端服务些带', 'description' => 'The server name indication (SNI) that is used to establish TLS links.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'www.aliyun.com', 'backendName' => 'sni'], ], 'backendName' => 'tls', ], 'LoadBalancerSettings' => [ - 'title' => '', + 'title' => '负载均衡相关配置', 'description' => 'The load balancing settings.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'LoadbalancerType' => [ - 'title' => '', + 'title' => '负载均衡类型，枚举类可为ROUND_ROBIN, LEAST_CONN,RANDOM, CONSISTENT_HASH', 'description' => 'The load balancing type. Valid values:'."\n" ."\n" .'* ROUND_ROBIN: round robin '."\n" .'* LEAST_CONN: least connection load balancing '."\n" .'* RANDOM: random load balancing '."\n" .'* CONSISTENT_HASH: consistent hashing load balancing '."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'RANDOM', 'backendName' => 'loadbalancerType', ], 'ConsistentHashLBConfig' => [ - 'title' => '', + 'title' => '一致性hash相关配置', 'description' => 'The data structure.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ParameterName' => [ - 'title' => '', - 'description' => 'The name of the object based on which consistent hashing is performed. If consistent hashing is performed based on a parameter, set the value to the parameter name. If consistent hashing is performed based on a header, set the value to the header name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'parameterName', - ], + 'ParameterName' => ['title' => '使用根据header和参数路由时生效', 'description' => 'The name of the object based on which consistent hashing is performed. If consistent hashing is performed based on a parameter, set the value to the parameter name. If consistent hashing is performed based on a header, set the value to the header name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'parameterName'], 'HttpCookie' => [ - 'title' => '', + 'title' => '使用cookie时配置', 'description' => 'You must specify this parameter only if ConsistentHashLBType is set to COOKIE.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The name of the cookie.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'name', - ], - 'Path' => [ - 'title' => 'cookie path', - 'description' => 'The path of the cookie.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '/path', - 'backendName' => 'path', - ], - 'TTL' => [ - 'title' => '', - 'description' => 'The lifecycle of the cookie.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '10s', - 'backendName' => 'ttl', - ], + 'Name' => ['title' => 'cookie名', 'description' => 'The name of the cookie.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'name'], + 'Path' => ['title' => 'cookie path', 'description' => 'The path of the cookie.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '/path', 'backendName' => 'path'], + 'TTL' => ['title' => 'cookie生命周期', 'description' => 'The lifecycle of the cookie.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10s', 'backendName' => 'ttl'], ], 'backendName' => 'httpCookie', ], @@ -960,7 +403,7 @@ .'* COOKIE: cookie'."\n" .'* SOURCE_IP: the source IP address'."\n" .'* HEADER: request header'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'QUERY_PARAMETER', @@ -969,14 +412,7 @@ ], 'backendName' => 'consistentHashLBConfig', ], - 'WarmupDuration' => [ - 'title' => '', - 'description' => 'The prefetch duration. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'warmupDuration', - ], + 'WarmupDuration' => ['title' => '预热时间(单位/s)', 'description' => 'The prefetch duration. Unit: seconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'warmupDuration', 'example' => '5'], ], 'enumValueTitles' => [], 'backendName' => 'loadBalancerSettings', @@ -986,621 +422,498 @@ ], ], 'apis' => [ - 'ListTagResources' => [ - 'summary' => 'Queries tagged resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAuthPolicy' => [ + 'summary' => 'You can call the AddAuthPolicy operation to create a service authentication rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '16988', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => 'The token used to start the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kywps2Ezza3n8HAAzCCqsi', - ], + 'schema' => ['description' => 'The source. The value can be \\`edasmsc\\`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'edasmsc', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'The type of the resource. Valid values:'."\n" - ."\n" - .'* CLUSTER: MSE instance'."\n" - .'* GATEWAY: cloud-native gateway'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CLUSTER', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'Enable', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2st29t16', - ], - 'required' => false, - 'maxItems' => 51, - ], + 'schema' => ['description' => 'Specifies whether to enable the authentication rule. Valid values:'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'AppId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => 'The list of tags. A maximum number of 20 tags are supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key-value pair of a tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'e9clba2xlc@***', 'title' => ''], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'- **SPRING\\_CLOUD**'."\n" + ."\n" + .'- **DUBBO**'."\n" + ."\n" + .'- **istio**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SPRING_CLOUD', 'title' => ''], + ], + [ + 'name' => 'AuthRule', + 'in' => 'query', + 'schema' => ['description' => 'The content of the service authentication rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"all":true,"black":false,"appIds":["dez4qt7weh@***"]}]', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The MSE namespace to which the application belongs.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'- 0: by application.'."\n" + ."\n" + .'- 1: by namespace.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'K8sNamespace', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace in the Kubernetes cluster.', 'type' => 'string', 'required' => false, 'example' => 'c19c6c500e1ff4d7abc7***', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values: zh-CN (default): Chinese, en-US: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', - 'description' => 'The token that is required for the next query. If the NextToken parameter is empty, no subsequent query is required.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '92ED7C9C-84A2-595F-87FE-354F84C0F739', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'title' => '资源列表', - 'description' => 'The list of resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of a resource and its tags, including the resource ID, the resource type, and the keys and values of the tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源ID', - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-7pp2st29t16', - ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'TagValue' => [ - 'title' => '标签值', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'prd', - ], - 'TagKey' => [ - 'title' => '标签键', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'env', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dc63-465d-8ef5-20dc18af****', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The data overview.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code. Its value is synchronized with the \\`Success\\` parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AddAuthPolicy', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:AddAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T\\",\\n \\"RequestId\\": \\"92ED7C9C-84A2-595F-87FE-354F84C0F739\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"mse-cn-7pp2st29t16\\",\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"prd\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListTagResources', + 'translator' => 'manual', ], - 'UntagResources' => [ - 'summary' => 'Untags resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAuthResource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', + 'abilityTreeCode' => '37110', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AuthId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the authorization record.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '13'], ], [ - 'name' => 'ResourceType', + 'name' => 'DomainId', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'The type of the resource. Valid values:'."\n" - ."\n" - .'* CLUSTER: MSE instance'."\n" - .'* GATEWAY: cloud-native gateway'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CLUSTER ', - ], + 'schema' => ['description' => 'The domain ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '128'], ], [ - 'name' => 'All', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', - 'description' => 'Specifies whether to delete all tags. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The path.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '/abc'], ], [ - 'name' => 'ResourceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID，最多50个子项', - 'description' => 'The resource IDs. A maximum of 50 resource IDs can be specified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> This parameter specifies the instance ID that is passed. Examples:'."\n" - ."\n" - .'* **ResourceId.1** specifies that the first instance ID is passed.'."\n" - .'* **ResourceId.2** specifies that the second instance ID is passed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2st29t16', - ], - 'required' => true, - 'maxItems' => 51, - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****'], ], [ - 'name' => 'TagKey', + 'name' => 'MatchType', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The matching type. Valid values:'."\n" + ."\n" + .'* EQUAL'."\n" + .'* PRE'."\n" + .'* ERGULAR'."\n", 'type' => 'string', 'required' => false, 'example' => 'exact'], + ], + [ + 'name' => 'IgnoreCase', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the matching is not case-sensitive. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AuthResourceHeaderList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '标签键，最多20个子项', - 'description' => 'The tag keys. A maximum of 20 tag keys are supported.'."\n", + 'description' => 'The authentication resource headers.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key must be 1 to 128 characters in length. The tag key cannot start with acs: or aliyun or contain [http:// or https://.](http://https://。)'."\n", - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => ['description' => 'The parameter of the HTTP header.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Access-Control-Allow-Origin'], + 'HeaderMethod' => [ + 'description' => 'The header matching mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SUFFIX'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* EXIST'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* PREFIX'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* EQUAL'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* EXCLUDE'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* NOT_EQUAL'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* NOT_EXIST'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* REGREX'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* INCLUDE'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['SUFFIX' => '', 'EXIST' => '', 'PREFIX' => '', 'EQUAL' => '', 'EXCLUDE' => '', 'NOT_EQUAL' => '', 'NOT_EXIST' => '', 'REGREX' => '', 'INCLUDE' => ''], + 'example' => 'EQUAL', + ], + 'HeaderValue' => ['description' => 'The parameter value of the HTTP header.'."\n", 'type' => 'string', 'required' => false, 'example' => '*'], + ], 'required' => false, - 'example' => 'env', ], 'required' => false, - 'maxItems' => 21, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '403'], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The data structure.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7\\",\\n \\"HttpStatusCode\\": 403,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 24\\n}","type":"json"}]', + 'title' => 'AddAuthResource', + 'summary' => 'Adds authorization information for a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddAuthResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UntagResources', ], - 'TagResources' => [ - 'summary' => 'Tags a specified resource.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddBlackWhiteList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '143129', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '36594', + 'abilityTreeNodes' => ['FEATUREmseWSG2U5'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0fe488252dc44d55a9dd57875193****'], ], [ 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'The type of the resources. Valid values:'."\n" - ."\n" - .'* CLUSTER: Microservices Engine (MSE) instance'."\n" - .'* GATEWAY: cloud-native gateway'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CLUSTER', - ], + 'schema' => ['description' => 'The effective scope of the blacklist or whitelist. Valid values:'."\n" + ."\n" + .'* GATEWAY'."\n" + .'* DOMAIN'."\n" + .'* ROUTE'."\n", 'type' => 'string', 'required' => false, 'example' => 'GATEWAY'], ], [ - 'name' => 'ResourceId', + 'name' => 'Type', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> This parameter specifies the instance ID that is passed. Examples:'."\n" - ."\n" - .'- ResourceId.0 specifies the first instance ID that is passed.'."\n" - .'- ResourceId.1 specifies the second instance ID that is passed.', - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2st29t16', - ], - 'required' => false, - 'maxItems' => 51, - ], + 'schema' => ['description' => 'The type of object in the blacklist or whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'IP'], ], [ - 'name' => 'Tag', + 'name' => 'Content', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about the tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key must be 1 to 128 characters in length. The tag key cannot start with acs: or aliyun or contain [http:// or https://.](http://https://。)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The content of the blacklist.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.117.115.51'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the blacklist.'."\n" + ."\n" + .'* on: enabled'."\n" + .'* off: disabled'."\n", 'type' => 'string', 'required' => false, 'example' => 'off'], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => 'The whitelist. Default value: No.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ResourceIdJsonList', + 'in' => 'query', + 'schema' => ['description' => 'The resource IDs in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '[123]'], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a note'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E0A79810-9396-521C-A09D-E757B3E2BAF4', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '966F6CA7-16D0-50AB-AB02-E140934F90C1'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The ID of the record.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"966F6CA7-16D0-50AB-AB02-E140934F90C1\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 2\\n}","type":"json"}]', + 'title' => 'AddBlackWhiteList', + 'summary' => 'Creates a blacklist or a whitelist.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0A79810-9396-521C-A09D-E757B3E2BAF4\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'TagResources', ], - 'UpdateMigrationTask' => [ - 'summary' => 'Updates a migration task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddGateway' => [ + 'summary' => 'Creates a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -1609,965 +922,697 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '155125', - 'abilityTreeNodes' => [ - 'FEATUREmseKDDXNL', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '24670', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The name of the gateway.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-ceshi'], ], [ - 'name' => 'Id', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the region where the gateway is deployed.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClusterType', + 'name' => 'Vpc', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instance. Valid values:'."\n" - ."\n" - .'* Nacos-Ans'."\n" - .'* ZooKeeper'."\n" - .'* Eureka'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['description' => 'The ID of the Virtual Private Cloud (VPC).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'vpc-bp15mncnrtm83uauxd1xb'], ], [ - 'name' => 'OriginInstanceAddress', + 'name' => 'ZoneInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The address of the source instance node.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.1:8848', + 'description' => 'The zone information. This parameter is required for multi-zone deployments.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object that contains zone information.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp*****', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OriginInstanceName', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Source instance'."\n", - ], + 'schema' => ['description' => 'The ID of the primary vSwitch. This parameter is required for single-zone deployments.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vsw-bp1q8th57frl5khj2li43'], ], [ - 'name' => 'OriginInstanceNamespace', + 'name' => 'VSwitchId2', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of namespaces. This parameter is optional if you want to migrate applications from a Nacos instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'namesapceId1,namesapceId2', - ], + 'schema' => ['description' => 'The ID of the secondary vSwitch. This parameter is required for multi-zone deployments.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vsw-wz9bu6o5vsvitt5mrxo6s'], ], [ - 'name' => 'TargetInstanceId', + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the destination instance.'."\n", + 'description' => 'The billing method of the gateway. This parameter is required for non-serverless instances.', + 'enumValueTitles' => ['PREPAY' => 'Subscription', 'POSTPAY' => 'Pay-As-You-Go'], 'type' => 'string', + 'enum' => ['PREPAY', 'POSTPAY'], 'required' => false, - 'example' => 'mse-cn-ud82*****', + 'example' => 'POSTPAY', + 'title' => '', ], ], [ - 'name' => 'TargetClusterName', + 'name' => 'MserVersion', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the destination instance.'."\n", + 'description' => 'The edition of the gateway.'."\n" + ."\n" + .'- `mse_premium`: Professional Edition'."\n" + ."\n" + .'- `mse_pro`: Standard Edition'."\n" + ."\n" + .'- `mse_serverless`: Serverless Edition', 'type' => 'string', + 'example' => 'mse_pro', + 'default' => 'mse_pro', + 'enum' => ['mse_premium', 'mse_pro', 'mse_serverless'], + 'title' => '', 'required' => false, - 'example' => 'Destination instance'."\n", ], ], [ - 'name' => 'TargetClusterUrl', + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => 'The URL of the destination instance.'."\n", + 'description' => 'The instance type of the gateway. This parameter is required for non-serverless instances.'."\n" + ."\n" + .'- MSE\\_GTW\\_16\\_32\\_200\\_c (16 Cores 32 GB)'."\n" + ."\n" + .'- MSE\\_GTW\\_2\\_4\\_200\\_c (2 Cores 4 GB)'."\n" + ."\n" + .'- MSE\\_GTW\\_4\\_8\\_200\\_c (4 Cores 8 GB)'."\n" + ."\n" + .'- MSE\\_GTW\\_8\\_16\\_200\\_c (8 Cores 16 GB)', + 'enumValueTitles' => ['MSE_GTW_16_32_200_c' => '16 Cores 32 GB', 'MSE_GTW_2_4_200_c' => '2 Cores, 4 GB', 'MSE_GTW_4_8_200_c' => '4 Cores, 8 GB', 'MSE_GTW_8_16_200_c' => '8 Cores 16 GB'], 'type' => 'string', 'required' => false, - 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', + 'enum' => ['MSE_GTW_2_4_200_c', 'MSE_GTW_4_8_200_c', 'MSE_GTW_8_16_200_c', 'MSE_GTW_16_32_200_c'], + 'title' => '', + 'example' => 'MSE_GTW_2_4_200_c', ], ], [ - 'name' => 'ProjectDesc', + 'name' => 'Replica', 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description.'."\n", - ], + 'schema' => ['description' => 'The number of gateway nodes. This parameter is required for non-serverless instances.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '2'], ], [ - 'name' => 'SyncType', + 'name' => 'ManagedEntryNetworkType', 'in' => 'query', 'schema' => [ + 'description' => 'The ingress type of the gateway. This parameter applies only to Professional Edition instances.'."\n" + ."\n" + .'- `pubnet`: Public Network'."\n" + ."\n" + .'- `privatenet`: Private Network'."\n" + ."\n" + .'- `privatepubnet`: Public and Private Networks', 'type' => 'string', + 'example' => 'pubnet', + 'enum' => ['pubnet', 'privatenet', 'privatepubnet'], + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'NlbNetworkType', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" + 'description' => 'The network type of the provisioned Network Load Balancer (NLB) instance.'."\n" ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", + .'- `pubnet`: Public Network'."\n" + ."\n" + .'- `privatenet`: Private Network'."\n" + ."\n" + .'- `privatepubnet`: Public and Private Networks'."\n" + ."\n" + .'> For non-serverless instances, you can provision only one of the following load balancer types: a Network Load Balancer (NLB) instance, a pay-by-LCU Classic Load Balancer (CLB) instance, or a pay-by-specification CLB instance.'."\n" + ."\n" + .'> For Serverless instances, you can provision either an NLB instance or a pay-by-LCU CLB instance.', 'type' => 'string', + 'enum' => ['pubnet', 'privatenet', 'privatepubnet'], + 'title' => '', 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '183876217*****', - ], - 'ClusterType' => [ - 'description' => 'The type of the instance.'."\n" - ."\n" - .'* Nacos-Ans'."\n" - .'* ZooKeeper'."\n" - .'* Eureka'."\n", - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'OriginInstanceAddress' => [ - 'description' => 'The address of the source instance node.'."\n", - 'type' => 'string', - 'example' => '192.168.100.2:2181', - ], - 'OriginInstanceName' => [ - 'description' => 'The name of the source instance.'."\n", - 'type' => 'string', - 'example' => 'src', - ], - 'OriginInstanceNamespace' => [ - 'description' => 'The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.'."\n", - 'type' => 'string', - 'example' => 'fsdfsdfdsf', - ], - 'TargetInstanceId' => [ - 'description' => 'The ID of the destination instance.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-zvp2u*****', - ], - 'TargetClusterName' => [ - 'description' => 'The name of the destination instance.'."\n", - 'type' => 'string', - 'example' => 'multiple-nacos', - ], - 'TargetClusterUrl' => [ - 'description' => 'The URL of the destination instance.'."\n", - 'type' => 'string', - 'example' => 'mse-0b*****-nacos-ans.mse.aliyuncs.com:8848', - ], - 'ProjectDesc' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '1232345', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'SyncType' => [ - 'type' => 'string', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'example' => 'pubnet', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"UserId\\": \\"183876217*****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.100.2:2181\\",\\n \\"OriginInstanceName\\": \\"src\\",\\n \\"OriginInstanceNamespace\\": \\"fsdfsdfdsf\\",\\n \\"TargetInstanceId\\": \\"mse-cn-zvp2u*****\\",\\n \\"TargetClusterName\\": \\"multiple-nacos\\",\\n \\"TargetClusterUrl\\": \\"mse-0b*****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"1232345\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"SyncType\\": \\"All\\"\\n },\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateMigrationTask', - ], - 'AddMigrationTask' => [ - 'summary' => 'Create a new migration task', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '155122', - 'abilityTreeNodes' => [ - 'FEATUREmseKDDXNL', - ], - ], - 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'ClbNetworkType', 'in' => 'query', 'schema' => [ - 'description' => 'Extended request parameters, in JSON format.', + 'description' => 'The network type of the provisioned pay-by-LCU Classic Load Balancer (CLB) instance.'."\n" + ."\n" + .'- `pubnet`: Public Network'."\n" + ."\n" + .'- `privatenet`: Private Network'."\n" + ."\n" + .'- `privatepubnet`: Public and Private Networks'."\n" + ."\n" + .'> For non-serverless instances, you can provision only one of the following load balancer types: a Network Load Balancer (NLB) instance, a pay-by-LCU Classic Load Balancer (CLB) instance, or a pay-by-specification CLB instance.'."\n" + ."\n" + .'> For Serverless instances, you can provision either an NLB instance or a pay-by-LCU CLB instance.', 'type' => 'string', + 'enum' => ['pubnet', 'privatenet', 'privatepubnet'], + 'title' => '', 'required' => false, - 'example' => '{}', + 'example' => 'pubnet', ], ], [ - 'name' => 'ClusterType', + 'name' => 'SlbSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'Cluster type.'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'required' => false, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['description' => 'The specifications of the internal-facing Classic Load Balancer (CLB) instance. This parameter applies to non-serverless instances.'."\n" + ."\n" + .'- slb.s1.small'."\n" + ."\n" + .'- slb.s2.small'."\n" + ."\n" + .'- slb.s2.medium'."\n" + ."\n" + .'- slb.s3.small'."\n" + ."\n" + .'- slb.s3.medium'."\n" + ."\n" + .'- slb.s3.large'."\n" + ."\n" + .'> For non-serverless instances, you can provision only one of the following load balancer types: a Network Load Balancer (NLB) instance, a pay-by-LCU Classic Load Balancer (CLB) instance, or a pay-by-specification CLB instance.'."\n" + ."\n" + .'> For Serverless instances, you can provision either an NLB instance or a pay-by-LCU CLB instance.', 'type' => 'string', 'deprecated' => true, 'title' => '', 'required' => false, 'example' => 'slb.s2.small'], ], [ - 'name' => 'OriginInstanceAddress', + 'name' => 'InternetSlbSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'Source instance node address.', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.1:8848', - ], + 'schema' => ['description' => 'The specifications of the public-facing Classic Load Balancer (CLB) instance. This parameter applies to non-serverless instances.'."\n" + ."\n" + .'- slb.s1.small'."\n" + ."\n" + .'- slb.s2.small'."\n" + ."\n" + .'- slb.s2.medium'."\n" + ."\n" + .'- slb.s3.small'."\n" + ."\n" + .'- slb.s3.medium'."\n" + ."\n" + .'- slb.s3.large'."\n" + ."\n" + .'> For non-serverless instances, you can provision only one of the following load balancer types: a Network Load Balancer (NLB) instance, a pay-by-LCU Classic Load Balancer (CLB) instance, or a pay-by-specification CLB instance.'."\n" + ."\n" + .'> For Serverless instances, you can provision either an NLB instance or a pay-by-LCU CLB instance.', 'type' => 'string', 'deprecated' => true, 'title' => '', 'required' => false, 'example' => 'slb.s2.small'], ], [ - 'name' => 'OriginInstanceName', + 'name' => 'EnterpriseSecurityGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'Source instance name.', - 'type' => 'string', - 'required' => false, - 'example' => 'Source instance'."\n", - ], + 'schema' => ['description' => 'Specifies whether to use an Enterprise Security Group.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'OriginInstanceNamespace', + 'name' => 'EnableHardwareAcceleration', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace list, required when the source cluster is Nacos.', - 'type' => 'string', - 'required' => false, - 'example' => 'namesapceId1,namesapceId2', - ], + 'schema' => ['description' => 'Specifies whether to enable hardware acceleration.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'TargetInstanceId', + 'name' => 'EnableXtrace', 'in' => 'query', - 'schema' => [ - 'description' => 'Target instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-ud82*****', - ], + 'schema' => ['description' => 'Specifies whether to enable Tracing Analysis.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'TargetClusterName', + 'name' => 'XtraceRatio', 'in' => 'query', - 'schema' => [ - 'description' => 'Target instance name.', - 'type' => 'string', - 'required' => false, - 'example' => 'Destination instance'."\n", - ], + 'schema' => ['description' => 'The sampling rate for Tracing Analysis. Valid values are integers from 1 to 100.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'TargetClusterUrl', + 'name' => 'EnableSls', 'in' => 'query', - 'schema' => [ - 'description' => 'Target instance URL.', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to enable log delivery to Simple Log Service (SLS).', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'ProjectDesc', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Description.', - 'type' => 'string', + 'title' => '', + 'description' => 'An array of tags to add to the gateway.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'key'], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'value'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'This is a description.'."\n", + 'maxItems' => 21, + 'example' => '', ], ], [ - 'name' => 'SyncType', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'SyncType', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'All' => 'All', - 'Config' => 'Config', - 'Service' => 'Service', - ], - 'example' => 'Service', - ], + 'schema' => ['description' => 'The ID of the Resource Group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm34x43l*****', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'Language type of the returned information:'."\n" - ."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. If you omit this parameter, the default value `en` is used.'."\n" + ."\n" + .'- `zh`: Chinese'."\n" + ."\n" + .'- `en`: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Data structure.', + 'title' => 'Schema of Response', + 'description' => 'The response data structure.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.'."\n" + ."\n" + .'- A success message is returned if the request is successful.'."\n" + ."\n" + .'- An error message is returned if the request fails.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Data structure.', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'Task ID.', - 'type' => 'string', - 'example' => '12', - ], - 'UserId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '183876217*****', - ], - 'ClusterType' => [ - 'description' => 'Cluster type.'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'OriginInstanceAddress' => [ - 'description' => 'Source instance node address.', - 'type' => 'string', - 'example' => '192.168.1.1:8848'."\n", - ], - 'OriginInstanceName' => [ - 'description' => 'Source instance name.', - 'type' => 'string', - 'example' => 'Source instance'."\n", - ], - 'OriginInstanceNamespace' => [ - 'description' => 'Namespace list, required when the source cluster is Nacos.', - 'type' => 'string', - 'example' => 'namesapceId1,namesapceId2', - ], - 'TargetInstanceId' => [ - 'description' => 'Target instance ID.', - 'type' => 'string', - 'example' => 'mse-cn-7pp2w*****', - ], - 'TargetClusterName' => [ - 'description' => 'Target instance name.', - 'type' => 'string', - 'example' => 'Destination instance'."\n", - ], - 'TargetClusterUrl' => [ - 'description' => 'Target instance URL.', - 'type' => 'string', - 'example' => 'mse-94d****-nacos-ans.mse.aliyuncs.com:8848', - ], - 'ProjectDesc' => [ - 'description' => 'Description.', - 'type' => 'string', - 'example' => 'testsdfsdfsd', - ], - 'SyncType' => [ - 'description' => 'SyncType', - 'type' => 'string', - 'example' => 'Service', - ], + 'GatewayUniqueId' => ['description' => 'The unique gateway ID.', 'type' => 'string', 'example' => 'gw-5017305290e14cebbrvec4a5****', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'Message' => [ - 'description' => 'Message.', - 'type' => 'string', - 'example' => 'The request is processed successfully.', - ], - 'ErrorCode' => [ - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Succ\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebbrvec4a5****\\"\\n }\\n}","type":"json"}]', + 'title' => 'AddGateway', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": \\"12\\",\\n \\"UserId\\": \\"183876217*****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.1.1:8848\\\\n\\",\\n \\"OriginInstanceName\\": \\"来源集群\\",\\n \\"OriginInstanceNamespace\\": \\"namesapceId1,namesapceId2\\",\\n \\"TargetInstanceId\\": \\"mse-cn-7pp2w*****\\",\\n \\"TargetClusterName\\": \\"目标集群\\",\\n \\"TargetClusterUrl\\": \\"mse-94d****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"testsdfsdfsd\\",\\n \\"SyncType\\": \\"Service\\"\\n },\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AddMigrationTask', - 'translator' => 'machine', ], - 'ListMigrationTask' => [ - 'summary' => 'Queries information about a migration task.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddGatewayAuth' => [ + 'summary' => 'Creates a gateway authentication rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '155119', - 'abilityTreeNodes' => [ - 'FEATUREmseKDDXNL', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '37105', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The authentication name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'OriginInstanceName', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'whdc', - ], + 'schema' => ['description' => 'The authentication method. Valid values:'."\n" + ."\n" + .'- JWT'."\n" + ."\n" + .'- OIDC'."\n" + ."\n" + .'- IDaaS'."\n" + ."\n" + .'- ExternalAuthZ (custom authentication service)', 'type' => 'string', 'required' => false, 'example' => 'JWT', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Issuer', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'This parameter applies when `Type` is `JWT` or `OIDC`.'."\n" + ."\n" + .'- For JWT authentication, this specifies the issuer (`iss`) of the JWT claims.'."\n" + ."\n" + .'- For OIDC authentication, this specifies the issuer (`iss`) of the OIDC claims.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/auth', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'Jwks', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The JWT public key in JSON Web Key Set (JWKS) format.', 'type' => 'string', 'required' => false, 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'TokenPosition', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Specifies the location of the JWT. Valid value:'."\n" + ."\n" + .'- HEADER: The token is in a request header.'."\n" + ."\n" + .'By default, the token is read from the `Authorization` header and must be prefixed with `Bearer `. For example: `Authorization: Bearer `.', 'type' => 'string', 'required' => false, 'example' => 'HEADER', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The array structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ClusterType' => [ - 'description' => 'The type of the instance.'."\n" - ."\n" - .'* Nacos-Ans'."\n" - .'* ZooKeeper'."\n" - .'* Eureka'."\n", - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'OriginInstanceAddress' => [ - 'description' => 'The address of the source instance node.'."\n", - 'type' => 'string', - 'example' => '192.168.1.1:8848', - ], - 'OriginInstanceName' => [ - 'description' => 'The name of the source instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'OriginInstanceNamespace' => [ - 'description' => 'The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.'."\n", - 'type' => 'string', - 'example' => 'fsdfsdfdsf', - ], - 'TargetInstanceId' => [ - 'description' => 'The ID of the destination instance.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-zv*****', - ], - 'TargetClusterName' => [ - 'description' => 'The name of the destination instance.'."\n", - 'type' => 'string', - 'example' => 'multiple-nacos', - ], - 'TargetClusterUrl' => [ - 'description' => 'The URL of the destination instance.'."\n", - 'type' => 'string', - 'example' => 'mse-f1******-nacos-ans.mse.aliyuncs.com:8848', - ], - 'ProjectDesc' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', - 'example' => '2021-12-30T06:41:52.000+0000', - ], - 'SyncType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '451EBE59-5F33-5B15-83C1-78593B9*****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the request header that contains the JWT.'."\n" + ."\n" + .'The default value is `Authorization`.', 'type' => 'string', 'required' => false, 'example' => 'Authorization', 'title' => ''], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + [ + 'name' => 'TokenNamePrefix', + 'in' => 'query', + 'schema' => ['description' => 'The prefix for the token value in the header.'."\n" + ."\n" + .'The default value is `Bearer `(note the trailing space).', 'type' => 'string', 'required' => false, 'example' => 'Bearer ', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to pass the token to the backend service after successful authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the authorization mode.'."\n" + ."\n" + .'- `true`: Whitelist mode. Requests that match the specified hosts and paths can bypass authentication. All other requests require authentication.'."\n" + ."\n" + .'- `false`: Blacklist mode. Requests that match the specified hosts and paths require authentication. All other requests can bypass authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is for internal use and should not be configured. Upon creation, an authentication rule is disabled by default.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"UserId\\": \\"2\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.1.1:8848\\",\\n \\"OriginInstanceName\\": \\"test\\",\\n \\"OriginInstanceNamespace\\": \\"fsdfsdfdsf\\",\\n \\"TargetInstanceId\\": \\"mse-cn-zv*****\\",\\n \\"TargetClusterName\\": \\"multiple-nacos\\",\\n \\"TargetClusterUrl\\": \\"mse-f1******-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"test\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2021-12-30T06:41:52.000+0000\\",\\n \\"SyncType\\": \\"Service\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"451EBE59-5F33-5B15-83C1-78593B9*****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListMigrationTask', - ], - 'DeleteMigrationTask' => [ - 'summary' => 'Deletes a migration task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'RedirectUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL to which the user is redirected after successful authentication. This parameter is required when `Type` is `OIDC` or `IDaaS`. The URL must match the redirect URL configured in the OIDC or IDaaS provider.', 'type' => 'string', 'required' => false, 'example' => 'https://test-.com/oauth2/callback', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'The client ID of the application registered with the identity provider. This parameter is required when `Type` is `OIDC` or `IDaaS`.', 'type' => 'string', 'required' => false, 'example' => '23460e2fdd9bf9ad106****', 'title' => ''], + ], + [ + 'name' => 'ClientSecret', 'in' => 'query', + 'schema' => ['description' => 'The client secret of the application registered with the identity provider. This parameter is required when `Type` is `OIDC` or `IDaaS`.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], + ], + [ + 'name' => 'CookieDomain', + 'in' => 'query', + 'schema' => ['description' => 'The cookie domain. After successful authentication, the gateway sends a cookie to this domain to keep the user signed in.'."\n" + ."\n" + .'For example, if you set `Cookie-domain=a.example.com`, the cookie is sent to the `a.example.com` domain. If you set `Cookie-domain=.example.com`, the cookie is sent to `example.com` and its subdomains.', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''], + ], + [ + 'name' => 'ScopesList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', + 'description' => 'The OIDC scopes. This parameter is required when `Type` is `OIDC`.', + 'type' => 'array', + 'items' => ['description' => 'An OIDC scope.', 'type' => 'string', 'required' => false, 'example' => 'openid', 'title' => ''], 'required' => false, - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'LoginUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the user logon page for the IDaaS instance. This parameter is required when `Type` is `IDaaS`.', 'type' => 'string', 'required' => false, 'example' => 'https://daxxxxcn.aliyunidaas.com/', 'title' => ''], + ], + [ + 'name' => 'Sub', + 'in' => 'query', + 'schema' => ['description' => 'The subject (`sub`) of the JWT claims. This parameter is used when `Type` is `JWT`. Ensure that the value of this parameter matches the `sub` field in the JWT payload. If this parameter is not set or is left empty, its value defaults to the value of the `Issuer` parameter.', 'type' => 'string', 'required' => false, 'example' => 'testing@secure.istio.io', 'title' => ''], + ], + [ + 'name' => 'ExternalAuthZJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', + 'description' => 'The settings for the custom authentication service.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The ID of the authentication service.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1343', 'title' => ''], + 'PrefixPath' => ['description' => 'The path of the authentication API provided by the authentication service. The path is matched by prefix.', 'type' => 'string', 'required' => false, 'example' => '/auth', 'title' => ''], + 'TokenKey' => ['description' => 'The request header that contains the token, such as `Authorization` or `Cookie`.', 'type' => 'string', 'required' => false, 'example' => 'Authorization', 'title' => ''], + 'AllowRequestHeaders' => [ + 'description' => 'The request headers to pass to the custom authentication service.', + 'type' => 'array', + 'items' => ['description' => 'The name of an allowed request header.', 'type' => 'string', 'required' => false, 'example' => 'x-req', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AllowUpstreamHeaders' => [ + 'description' => 'The response headers from the custom authentication service to pass to the backend service.', + 'type' => 'array', + 'items' => ['description' => 'The name of an allowed response header.', 'type' => 'string', 'required' => false, 'example' => 'x-resp', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Timeout' => ['description' => 'The timeout for the custom authentication service, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'IsRestrict' => ['description' => 'Specifies the behavior when the custom authentication service is unavailable:'."\n" + ."\n" + .'- `true`: Strict mode. If the authentication service is unavailable (for example, due to a connection failure or a 5xx error), the gateway rejects the client request.'."\n" + ."\n" + .'- `false`: Permissive mode. If the authentication service is unavailable, the gateway allows the client request to pass through.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'WithRequestBody' => ['description' => 'Specifies whether to include the request body in the request sent to the custom authentication service.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'BodyMaxBytes' => ['description' => 'The maximum size of the request body that can be sent to the custom authentication service, in bytes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4000000', 'title' => ''], + 'WithRematchRoute' => ['description' => 'Specifies whether to rematch the route after the authentication is complete.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => false, 'example' => 'gw-*****9b04bb4474cae9d645be850e3d7', 'title' => ''], + ], + [ + 'name' => 'AuthResourceMode', + 'in' => 'query', + 'schema' => ['description' => 'The mode for configuring authorization resources. Valid values:'."\n" + ."\n" + .'- 0: Simple mode'."\n" + ."\n" + .'- 1: Advanced mode', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AuthResourceConfig', + 'in' => 'query', + 'schema' => ['description' => 'The YAML configuration for the advanced mode.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'AuthResourceList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + 'description' => 'The list of authorization rules. Multiple rules are evaluated with a logical OR. Within a single rule, multiple match conditions are evaluated with a logical AND.', + 'type' => 'array', + 'items' => [ + 'description' => 'The settings for an authorization rule.', + 'type' => 'object', + 'properties' => [ + 'DomainId' => ['description' => 'The ID of the domain name to which the rule applies.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1765', 'title' => ''], + 'Path' => ['description' => 'The request path to match.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], + 'MatchType' => ['description' => 'The match type for the path. Valid values:'."\n" + ."\n" + .'- EQUAL: Exact match'."\n" + ."\n" + .'- PRE: Prefix match'."\n" + ."\n" + .'- REGEX: Regular expression match', 'type' => 'string', 'required' => false, 'example' => 'EQUAL', 'title' => ''], + 'IgnoreCase' => ['description' => 'Specifies whether path matching is case-sensitive. This parameter is applicable only to custom authentication rules. For other authentication methods, path matching is case-sensitive by default.'."\n" + ."\n" + .'- `true`: Path matching is case-insensitive.'."\n" + ."\n" + .'- `false`: Path matching is case-sensitive.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'AuthResourceHeaderList' => [ + 'description' => 'A list of request header conditions to match. This parameter is applicable only to custom authentication rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => ['description' => 'The name of the request header.', 'type' => 'string', 'required' => false, 'example' => 'x-req', 'title' => ''], + 'HeaderMethod' => ['description' => 'The match condition. Valid values:'."\n" + ."\n" + .'- EQUAL: Equal to'."\n" + ."\n" + .'- NOT\\_EQUAL: Not equal to'."\n" + ."\n" + .'- EXIST: Exists'."\n" + ."\n" + .'- NOT\\_EXIST: Does not exist'."\n" + ."\n" + .'- INCLUDE: Contains'."\n" + ."\n" + .'- EXCLUDE: Does not contain'."\n" + ."\n" + .'- PREFIX: Has prefix'."\n" + ."\n" + .'- SUFFIX: Has suffix'."\n" + ."\n" + .'- REGEX: Regular expression match', 'type' => 'string', 'required' => false, 'example' => 'EQUAL', 'title' => ''], + 'HeaderValue' => ['description' => 'The value of the request header.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values: `zh` (Chinese) and `en` (English). The default value is `zh`.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The deletion result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4279C00F-A5E1-53C6-A43B-751C1C524D0B'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The response code. A value of `200` indicates that `Success` is `true`.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The ID of the created authentication rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '333', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteMigrationTask', - ], - 'PutClusterHealthCheckTask' => [ - 'summary' => 'Initiates a task to check risk evaluation for an instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'cluster', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4279C00F-A5E1-53C6-A43B-751C1C524D0B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 333\\n}","type":"json"}]', + 'title' => 'AddGatewayAuth', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'AddGatewayAuthConsumer' => [ + 'summary' => 'Adds a consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -2575,1117 +1620,712 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-2r42o83h506', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the consumer.'."\n", 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", 'type' => 'string', 'required' => true, 'example' => 'JWT', 'title' => ''], + ], + [ + 'name' => 'EncodeType', + 'in' => 'query', + 'schema' => ['description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* RSA'."\n" + .'* OCT'."\n", 'type' => 'string', 'required' => false, 'example' => 'RSA', 'title' => ''], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => ['description' => 'The JWT public key. The JSON format is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', 'title' => ''], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => ['description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Authorization', 'title' => ''], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable pass-through.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => ['description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HEADER', 'title' => ''], + ], + [ + 'name' => 'TokenPrefix', + 'in' => 'query', + 'schema' => ['description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Bearer ', 'title' => ''], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the key used for JWT-based identity authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iss', 'title' => ''], + ], + [ + 'name' => 'KeyValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of the key used for JWT-based identity authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcd', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the consumer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The response parameters.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'boolean', - 'example' => 'null', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the `%s` variable in the `ErrMessage` parameter.'."\n" + ."\n" + .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 2\\n}","type":"json"}]', + 'title' => 'AddGatewayAuthConsumer', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayAuthConsumer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'PutClusterHealthCheckTask', ], - 'OrderClusterHealthCheckRiskNotice' => [ - 'summary' => 'Subscribes to the notification feature if a risk is detected during a health check.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddGatewayDomain' => [ + 'summary' => 'Associates a domain name with a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '150983', - 'abilityTreeNodes' => [ - 'FEATUREmseZDUZ1K', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'MustHttps', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'Specifies whether to enable HTTPS.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'RiskCode', + 'name' => 'CertIdentifier', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the risk item.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30010010001', - ], + 'schema' => ['description' => 'The ID of the certificate.'."\n", 'type' => 'string', 'required' => false, 'example' => '6828169-cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Mute', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to disable the notification feature if the risk item occurs.'."\n" - ."\n" - .'* true: disabled'."\n" - .'* false: enabled'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test.com', 'title' => ''], ], [ - 'name' => 'NoticeType', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The type of the protocol. Valid values:'."\n" + ."\n" + .'* `HTTP`'."\n" + .'* `HTTPS`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region in which the cluster resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', 'title' => ''], ], [ - 'name' => 'RequestPars', + 'name' => 'Http2', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'Specifies whether to enable `HTTP/2`.'."\n" + ."\n" + .'* `open`: enables `HTTP/2`'."\n" + .'* `close`: disables `HTTP/2`'."\n" + .'* `globalConfig`: uses global configurations'."\n", 'type' => 'string', 'required' => false, 'example' => 'close', 'title' => ''], + ], + [ + 'name' => 'TlsMax', + 'in' => 'query', + 'schema' => ['description' => 'The maximum version of Transport Layer Security (TLS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'TLS 1.3', 'title' => ''], + ], + [ + 'name' => 'TlsMin', + 'in' => 'query', + 'schema' => ['description' => 'The minimum version of TLS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TLS 1.0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether the subscription was successful.'."\n", - 'type' => 'boolean', - 'example' => 'null', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16BA802F-B848-55DF-9F57-CD71B7272D1F'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'OrderClusterHealthCheckRiskNotice', - ], - 'ListClusterHealthCheckTask' => [ - 'summary' => 'Obtains information about historical health check tasks.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16BA802F-B848-55DF-9F57-CD71B7272D1F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 100\\n}","type":"json"}]', + 'title' => 'AddGatewayDomain', + 'changeSet' => [ + ['createdAt' => '2026-03-12T02:35:25.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-03-03T08:16:53.000Z', 'description' => 'OpenAPI offline'], ], - 'tags' => [ - 'cluster', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'AddGatewayRoute' => [ + 'summary' => 'Adds a route to a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '150980', - 'abilityTreeNodes' => [ - 'FEATUREmseZDUZ1K', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '25612', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-7pp2o4wfx01', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '526', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '查询第几页', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RouteOrder', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示条数', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The sequence number of the route. (A small value indicates a high priority.)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Predicates', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'description' => 'The matching rule.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed. Take note of the following rules:'."\n" - ."\n" - .'* The **ErrorCode** parameter is not returned if the request is successful.'."\n" - .'* The **ErrorCode** parameter is returned if the request fails. For more information, see the **Error codes** section in this topic.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'PathPredicates' => [ + 'description' => 'The route matching type.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'Path' => ['description' => 'The path.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], + 'Type' => [ + 'description' => 'The route matching type. Valid values:'."\n" + ."\n" + .'- PRE: prefix matching'."\n" + ."\n" + .'- EQUAL: exact matching'."\n" + ."\n" + .'- ERGULAR: regular expression matching', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + 'title' => '', ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', + 'IgnoreCase' => ['description' => 'Specifies whether to ignore case sensitivity.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.', + 'type' => 'array', + 'items' => ['description' => 'The method.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HeaderPredicates' => [ + 'description' => 'The information about header matching.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The request header key.', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''], + 'Value' => ['description' => 'The corresponding value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The matching type.', 'type' => 'string', 'required' => false, 'example' => 'PRE', 'title' => ''], ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'QueryPredicates' => [ + 'description' => 'The URL parameter matching.', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'userid', 'title' => ''], + 'Value' => ['description' => 'The value of the matching condition.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The matching type.', 'type' => 'string', 'required' => false, 'example' => 'PRE', 'title' => ''], ], - 'Result' => [ - 'description' => 'The list of health check tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The health check task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Score' => [ - 'description' => 'The total score.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'TotalItem' => [ - 'description' => 'The total number of check items.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalRisk' => [ - 'description' => 'The total number of risk items.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse_ingresspost-cn-0jbvrcex****', - ], - 'ClusterType' => [ - 'description' => 'The type of the cluster.'."\n", - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'Type' => [ - 'description' => 'A redundant parameter.'."\n", - 'type' => 'string', - 'example' => 'null'."\n", - ], - 'Status' => [ - 'description' => 'The status of the task.'."\n", - 'type' => 'string', - 'example' => 'FINISH', - ], - 'PrimaryUser' => [ - 'description' => 'The ID of the user to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'Spec' => [ - 'description' => 'The specifications.'."\n", - 'type' => 'string', - 'example' => 'MSE_SC_2_4_200_c', - ], - 'Replica' => [ - 'description' => 'The number of nodes in the instance.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'VersionCode' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'example' => 'NACOS_ANS_1_2_1_3', - ], - 'AppVersion' => [ - 'description' => 'The complete version number.'."\n", - 'type' => 'string', - 'example' => '1.2.1', - ], - 'ImageVersion' => [ - 'description' => 'A redundant parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2022-06-20T06:51:46Z', - ], - 'UpdateTime' => [ - 'description' => 'The last update time.'."\n", - 'type' => 'string', - 'example' => '2022-11-12 15:07:55', - ], - 'RiskList' => [ - 'description' => 'The list of risk items.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about risk items.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3426', - ], - 'TaskId' => [ - 'description' => 'The ID of the associated parent task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RiskName' => [ - 'description' => 'The name of the risk.'."\n", - 'type' => 'string', - 'example' => 'The engine version is outdated.'."\n", - ], - 'RiskCode' => [ - 'description' => 'The risk code.'."\n", - 'type' => 'string', - 'example' => '22020010001', - ], - 'PrimaryUser' => [ - 'description' => 'The ID of the user to which the cluster belongs.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'Type' => [ - 'description' => 'A redundant parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'Values' => [ - 'description' => 'A redundant parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Module' => [ - 'description' => 'A redundant parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'RiskType' => [ - 'description' => 'The type of the risk.'."\n", - 'type' => 'string', - 'example' => 'Version risk'."\n", - ], - 'RiskLevel' => [ - 'title' => 'HIGH, MID, LOW, NONE', - 'description' => 'The severity of the risk. Valid values:'."\n" + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Services', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The service that you want to associate with the gateway. This parameter is required if the Route Point parameter is set to Single Service, Multiple Services, or Label routing.', + 'type' => 'array', + 'items' => [ + 'description' => 'The service list.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '353', 'title' => ''], + 'Percent' => ['description' => 'The traffic weight of the service of a specific version, in percentage. This parameter is required if the Route Point parameter is set to Multiple Services or Label routing.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'Version' => ['description' => 'The service version. This parameter is required only if the Route Point parameter is set to Label routing.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + 'SourceType' => ['description' => 'The type of the source.', 'type' => 'string', 'required' => false, 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace to which the service belongs.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'GroupName' => ['description' => 'The name of the service group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'AgreementType' => ['description' => 'The Protocol Type.', 'type' => 'string', 'required' => false, 'example' => 'DUBBO', 'title' => ''], + 'HttpDubboTranscoder' => [ + 'description' => 'The Dubbo protocol converter.', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'The Dubbo service name.', 'type' => 'string', 'required' => false, 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', 'title' => ''], + 'DubboServiceVersion' => ['description' => 'The Dubbo service version.', 'type' => 'string', 'required' => false, 'example' => '0.0.0', 'title' => ''], + 'DubboServiceGroup' => ['description' => 'The service group.', 'type' => 'string', 'required' => false, 'example' => 'group', 'title' => ''], + 'MothedMapList' => [ + 'description' => 'The Dubbo forwarding rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The method mapping.', + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'The Dubbo method name.', 'type' => 'string', 'required' => false, 'example' => 'sayHello', 'title' => ''], + 'HttpMothed' => ['description' => 'The HTTP method.'."\n" + ."\n" + .'> Supported HTTP method parameter values:'."\n" + .'>'."\n" + .'> - ALL\\_GET.'."\n" + .'>'."\n" + .'> - ALL\\_POST.'."\n" + .'>'."\n" + .'> - ALL\\_PUT.'."\n" + .'>'."\n" + .'> - ALL\\_DELETE.'."\n" + .'>'."\n" + .'> - ALL\\_PATCH.', 'type' => 'string', 'required' => false, 'example' => 'ALL_GET', 'title' => ''], + 'Mothedpath' => ['description' => 'The path that is used to match a method.', 'type' => 'string', 'required' => false, 'example' => '/mytestzbk/sayhello', 'title' => ''], + 'PassThroughAllHeaders' => ['description' => 'The pass-through type of the header.'."\n" + ."\n" + .'> Enumeration values for pass-through types:'."\n" + .'>'."\n" + .'> - PASS\\_ALL: All headers are passed through.'."\n" + .'>'."\n" + .'> - PASS\\_NOT: All headers are not passed through.'."\n" + .'>'."\n" + .'> - PASS\\_ASSIGN: Specified headers are passed through.', 'type' => 'string', 'required' => false, 'example' => 'PASS_NOT', 'title' => ''], + 'PassThroughList' => [ + 'description' => 'The headers that are passed through.', + 'type' => 'array', + 'items' => ['description' => 'The header value that is passed through.', 'type' => 'string', 'required' => false, 'example' => 'x-forward', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ParamMapsList' => [ + 'description' => 'The information about parameter mappings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter mapping object.', + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => 'The input parameter position.'."\n" ."\n" - .'* HIGH: high risk'."\n" - .'* MID: medium risk'."\n" - .'* LOW: low risk'."\n", - 'type' => 'string', - 'example' => 'MID', - ], - 'Suggestion' => [ - 'description' => 'The suggestion.'."\n", - 'type' => 'string', - 'example' => '{"desc": "Upgrade to the latest version at the earliest opportunity.", "links":\\[{"type": "upgrade", "desc": "Click to upgrade"}]}'."\n", - ], - 'Situation' => [ - 'description' => 'The situation.'."\n", - 'type' => 'string', - 'example' => '{\\\\"desc\\\\":\\\\"The engine version is outdated and a large number of features are not supported.\\\\",\\\\"links\\\\":\\[{\\\\"type\\\\":\\\\"url\\\\",\\\\"value\\\\":\\\\"https://xxxx"\\\\",\\\\"desc\\\\":\\\\"Release notes\\\\"}]}'."\n", - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '{\\\\"desc\\\\":\\\\"The engine version is outdated and a large number of features are not supported. Upgrade the engine to the latest version at the earliest opportunity. \\\\"}'."\n", - ], - 'Mute' => [ - 'description' => 'Indicates whether the risk item notification feature is disabled.'."\n" + .'> Enumeration values for input parameter positions:'."\n" + .'>'."\n" + .'> - Request parameter: `ALL_QUERY_PARAMETER`'."\n" ."\n" - .'* true: disabled'."\n" - .'* false: enabled'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'NoticeFeature' => [ - 'description' => 'A redundant parameter.'."\n", - 'type' => 'boolean', - 'example' => 'null', - ], - 'RiskNameEn' => [ - 'type' => 'string', - ], - 'SuggestionEn' => [ - 'type' => 'string', - ], - 'SituationEn' => [ - 'type' => 'string', - ], - 'DescriptionEn' => [ - 'type' => 'string', + .'- Request header: `ALL_HEADER`'."\n" + ."\n" + .'- URI of the request: `ALL_PATH`'."\n" + ."\n" + .'- Request body: `ALL_BODY`', 'type' => 'string', 'required' => false, 'example' => 'ALL_QUERY_PARAMETER', 'title' => ''], + 'ExtractKey' => ['description' => 'The key of the input parameter that is extracted.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'MappingType' => ['description' => 'The type of the backend service parameter.', 'type' => 'string', 'required' => false, 'example' => 'java.lang.String', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'ChargeType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'PREPAY', - ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'ServicePort' => ['description' => 'The service port number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 9,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Score\\": 60,\\n \\"TotalItem\\": 10,\\n \\"TotalRisk\\": 3,\\n \\"InstanceId\\": \\"mse_ingresspost-cn-0jbvrcex****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"Type\\": \\"null\\\\n\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"PrimaryUser\\": \\"123456\\",\\n \\"Spec\\": \\"MSE_SC_2_4_200_c\\",\\n \\"Replica\\": \\"3\\",\\n \\"VersionCode\\": \\"NACOS_ANS_1_2_1_3\\",\\n \\"AppVersion\\": \\"1.2.1\\",\\n \\"ImageVersion\\": \\"null\\",\\n \\"CreateTime\\": \\"2022-06-20T06:51:46Z\\",\\n \\"UpdateTime\\": \\"2022-11-12 15:07:55\\",\\n \\"RiskList\\": [\\n {\\n \\"Id\\": 3426,\\n \\"TaskId\\": 1,\\n \\"RiskName\\": \\"引擎版本过低\\",\\n \\"RiskCode\\": \\"22020010001\\",\\n \\"PrimaryUser\\": \\"123456\\",\\n \\"Type\\": 0,\\n \\"Values\\": \\"null\\",\\n \\"Module\\": \\"null\\",\\n \\"RiskType\\": \\"版本风险\\",\\n \\"RiskLevel\\": \\"MID\\",\\n \\"Suggestion\\": \\"{\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"请尽快升级至最新版本\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"links\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"upgrade\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"点击升级\\\\\\\\\\\\\\"}]}\\",\\n \\"Situation\\": \\"{\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"当前引擎版本过低，有大量功能缺失\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"links\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://xxxx\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"版本说明\\\\\\\\\\\\\\"}]}\\",\\n \\"Description\\": \\"{\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\\\\\\\\\\\\\\"}\\",\\n \\"Mute\\": false,\\n \\"NoticeFeature\\": true,\\n \\"RiskNameEn\\": \\"Low engine version\\",\\n \\"SuggestionEn\\": \\"Upgrade to the latest version\\",\\n \\"SituationEn\\": \\"The current engine version is low, and there are many missing features\\",\\n \\"DescriptionEn\\": \\"Upgrade to the latest version to ensure that all features are available!\\"\\n }\\n ],\\n \\"ChargeType\\": \\"PREPAY\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListClusterHealthCheckTask', - ], - 'ListConfigTrack' => [ - 'summary' => 'Obtains the track data of a Nacos configuration center.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '139046', - 'abilityTreeNodes' => [ - 'FEATUREmseU19WQV', + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => ['description' => 'The domain ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'DestinationType', 'in' => 'query', 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", + 'description' => 'The destination service type.'."\n" + ."\n" + .'- Single: Single Service'."\n" + ."\n" + .'- Multiple: Multiple Services'."\n" + ."\n" + .'- VersionOriented: Label routing'."\n" + ."\n" + .'- Mock: Mock'."\n" + ."\n" + .'- Redirect: Redirect', + 'enumValueTitles' => ['VersionOriented' => 'VersionOriented', 'Multiple' => 'Multiple', 'Single' => 'Single', 'Redirect' => 'Redirect', 'Mock' => 'Mock'], 'type' => 'string', 'required' => false, - 'example' => '{}', + 'example' => 'Multiple', + 'title' => '', ], ], [ - 'name' => 'InstanceId', + 'name' => 'DirectResponseJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mse_prepaid_public_cn-i7m2ne****', + 'description' => 'The Mock response configuration.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The Mock return code.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '403', 'title' => ''], + 'Body' => ['description' => 'The return value.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ballot', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-492af9b04bb4474cae9d645be8*****', 'title' => ''], ], [ - 'name' => 'Group', + 'name' => 'DomainIdListJSON', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The IDs of domains.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '[0,94]', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'RedirectJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', + 'description' => 'The configuration of the redirect action.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status codes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '302', 'title' => ''], + 'Host' => ['description' => 'The hostname to be redirected to.', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''], + 'Path' => ['description' => 'The path to be redirected to.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], + ], 'required' => false, - 'example' => 'f3a510e2-df52-4fad-9815-42d8bc40****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StartTs', + 'name' => 'EnableWaf', 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1671010148', - ], + 'schema' => ['description' => 'Deprecated. Use UpdateGatewayRouteWafStatus to update the WAF status of a route.', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'EndTs', + 'name' => 'Fallback', 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657178373', - ], + 'schema' => ['description' => 'Indicates whether to enable the Fallback service.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'FallbackServices', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', + 'description' => 'The Fallback services.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '353', 'title' => ''], + 'Percent' => ['description' => 'The weight in the form of a percentage value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'Version' => ['description' => 'The version of the service.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + 'SourceType' => ['description' => 'The type of the source.', 'type' => 'string', 'required' => false, 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace in which the service resides.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'GroupName' => ['description' => 'The name of the group to which the service belongs.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'AgreementType' => ['description' => 'The Protocol Type.', 'type' => 'string', 'required' => false, 'example' => 'DUBBO', 'title' => ''], + 'ServicePort' => ['description' => 'The service port number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNum', + 'name' => 'RouteType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The type of route. Valid values:'."\n" + ."\n" + .'Op: Management route.', 'type' => 'string', 'required' => false, 'example' => 'Op', 'title' => ''], ], [ - 'name' => 'Reverse', + 'name' => 'Policies', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable reverse ordering. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The routing policy in a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{"CORS":"{\\"allowMethods\\":\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\"allowHeaders\\":\\"*\\",\\"exposeHeaders\\":\\"*\\",\\"unitNum\\":12,\\"allowCredentials\\":true,\\"status\\":\\"off\\",\\"allowOrigins\\":\\"*\\",\\"timeUnit\\":\\"h\\"}","Timeout":"{\\"unitNum\\":10,\\"timeUnit\\":\\"s\\",\\"status\\":\\"off\\"}","Retry":"{\\"attempts\\":2,\\"retryOn\\":[\\"5xx\\"],\\"status\\":\\"off\\"}","HTTPRewrite":"{\\"pathType\\":\\"EQUAL\\",\\"path\\":\\"/o\\",\\"status\\":\\"off\\"}","Waf":"{\\"enabled\\":false}","HeaderOp":"{\\"status\\":\\"off\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Add\\",\\"key\\":\\"kkk\\",\\"value\\":\\"ll\\"}]}"}', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address of the listener.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.22.2', - ], + 'schema' => ['description' => 'The route description.', 'type' => 'string', 'example' => 'a route for xxx', 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Traces' => [ - 'description' => 'The track data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'LogDate' => [ - 'description' => 'The logging time.'."\n", - 'type' => 'string', - 'example' => '2022-11-28 15:09:15', - ], - 'Ts' => [ - 'description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '1659666529', - ], - 'RequestIp' => [ - 'description' => 'The source IP address of the request.'."\n", - 'type' => 'string', - 'example' => '192.168.1.2', - ], - 'ResponseIp' => [ - 'description' => 'The response node.'."\n", - 'type' => 'string', - 'example' => 'mse-1973b9a0-1670834*****-reg-center-0-2', - ], - 'DataId' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'string', - 'example' => 'eir-server.properties', - ], - 'Group' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'Event' => [ - 'description' => 'The event. Valid values:'."\n" - ."\n" - .'* pull: configuration acquisition events'."\n" - .'* persist: persistence events'."\n", - 'type' => 'string', - 'example' => 'pull', - ], - 'Result' => [ - 'description' => 'The result.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'Delay' => [ - 'description' => 'The response latency. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Md5' => [ - 'description' => 'The MD5 value.'."\n", - 'type' => 'string', - 'example' => 'd21c9091c60daa0ff7ee2f420141e5a0', - ], - 'Type' => [ - 'description' => 'The release type. Valid values:'."\n" - ."\n" - .'* beta: beta release'."\n" - .'* tag: canary release'."\n" - .'* batch: batch release'."\n", - 'type' => 'string', - 'example' => 'beta', - ], - 'Push' => [ - 'description' => 'Indicates whether messages are pushed by a server. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Client' => [ - 'description' => 'Indicates whether the request is sent from the client. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0CE3ABD2-1E04-561F-A9B4-0423D50****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '555', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n" + ."\n" + .'- InvalidParameter: The parameter is invalid. For example, the parameter is incomplete or the parameter format is invalid.'."\n" + ."\n" + .'- IllegalRequest: The request is invalid. Unauthorized access to data initiated by parameters is identified.'."\n" + ."\n" + .'- NoPermission: You are not authorized to perform this operation.'."\n" + ."\n" + .'- NotFound: The resource does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 555,\\n \\"ErrorCode\\": \\"InvalidParameter\\"\\n}","type":"json"}]', + 'title' => 'AddGatewayRoute', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"LogDate\\": \\"2022-11-28 15:09:15\\",\\n \\"Ts\\": \\"1659666529\\",\\n \\"RequestIp\\": \\"192.168.1.2\\",\\n \\"ResponseIp\\": \\"mse-1973b9a0-1670834*****-reg-center-0-2\\",\\n \\"DataId\\": \\"eir-server.properties\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"Event\\": \\"pull\\",\\n \\"Result\\": \\"ok\\",\\n \\"Delay\\": \\"0\\",\\n \\"Md5\\": \\"d21c9091c60daa0ff7ee2f420141e5a0\\",\\n \\"Type\\": \\"beta\\",\\n \\"Push\\": false,\\n \\"Client\\": false\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"0CE3ABD2-1E04-561F-A9B4-0423D50****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListConfigTrack', ], - 'CreateNacosConfig' => [ - 'summary' => 'Creates a Nacos configuration.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddGatewayServiceVersion' => [ + 'summary' => 'Adds a service version for a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -3694,317 +2334,329 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17005', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '90280', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-tl32****', - ], + 'schema' => ['description' => 'The ID of the service.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '33', 'title' => ''], ], [ - 'name' => 'DataId', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'common.yaml', - ], + 'schema' => ['description' => 'The version of the service.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{\\"name\\":\\"v1\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v1\\"}]}', 'title' => ''], ], [ - 'name' => 'Group', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alime-bridge-aliyun', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-913a49bab6c5461187a3305fb8da****', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'saledatacenter-task', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BA4046B6-CFC6-583C-B608-DD75011A590F'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '403', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned. The value 200 indicates that the request is successfully processed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The ID of the gateway service.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '330', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tags of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Basic configurations'."\n", - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA4046B6-CFC6-583C-B608-DD75011A590F\\",\\n \\"HttpStatusCode\\": 403,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 330\\n}","type":"json"}]', + 'title' => 'AddGatewayServiceVersion', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Desc', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Basic module configuration.'."\n", + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayServiceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'AddGatewaySlb' => [ + 'summary' => 'Associates a Server Load Balancer (SLB) instance with a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '71795', + 'abilityTreeNodes' => ['FEATUREmseMNDRFM'], + ], + 'parameters' => [ + [ + 'name' => 'SlbId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the SLB instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'lb-bp18t6jjskwxh6wy1****', 'title' => ''], + ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The format of the configuration. Supported formats include TEXT, JSON, and XML.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'text', - ], + 'schema' => ['description' => 'The type of the service source. Valid values:'."\n" + ."\n" + .'* PUB_NET: Internet'."\n" + .'* PRIVATE_NET: VPC'."\n", 'type' => 'string', 'required' => false, 'example' => 'PUB_NET', 'title' => ''], ], [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The content of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'asdf', - ], + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'VServerGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '547fd2a0-d0d6-****-80db2a1afb82', - ], + 'schema' => ['description' => 'The ID of the HTTP virtual service group.'."\n", 'type' => 'string', 'required' => false, 'example' => '353', 'title' => ''], ], [ - 'name' => 'BetaIps', + 'name' => 'ServiceWeight', + 'in' => 'query', + 'schema' => ['description' => 'The service weight.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'HttpPort', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP port number (virtual service group).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'HttpsPort', + 'in' => 'query', + 'schema' => ['description' => 'The HTTPS port number (virtual service group).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443', 'title' => ''], + ], + [ + 'name' => 'HttpsVServerGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the HTTPS virtual service group.'."\n", 'type' => 'string', 'required' => false, 'example' => '353', 'title' => ''], + ], + [ + 'name' => 'VServiceList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The list of IP addresses where the beta release of the configuration is performed.'."\n", - 'type' => 'string', + 'description' => 'The SLB monitoring information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => ['description' => 'The ID of the virtual server group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rsp-bp1j**t0fyl**', 'title' => ''], + 'VServerGroupName' => ['description' => 'The name of the virtual server group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'k8s/31**0/***/istio-system/clusterid', 'title' => ''], + 'Port' => ['description' => 'The port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443', 'title' => ''], + 'Protocol' => ['description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", 'type' => 'string', 'required' => false, 'example' => 'HTTPS', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '100.117.XX.XX,100.117.XX.XX', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '673DBD43-569E-510F-B3DE-20BB8DFEB20A', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The code returned.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The data returned.'."\n", 'type' => 'string', 'example' => 'lb-uf6dqr4ondqi5w3df7hdf', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Nacos.Intercepted', - 'errorMessage' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"lb-uf6dqr4ondqi5w3df7hdf\\"\\n}","type":"json"}]', + 'title' => 'AddGatewaySlb', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"673DBD43-569E-510F-B3DE-20BB8DFEB20A\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"1\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateNacosConfig', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'DeleteNacosConfig' => [ - 'summary' => 'Delete specified Nacos configuration', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddMigrationTask' => [ + 'summary' => 'Create a new migration task', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17011', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '155122', + 'abilityTreeNodes' => ['FEATUREmseKDDXNL'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-tl32epfyu18', - ], + 'schema' => ['description' => 'Extended request parameters, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'DataId', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'user-ds.yml', - ], + 'schema' => ['description' => 'Cluster type.'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'required' => false, 'example' => 'Nacos-Ans', 'title' => ''], ], [ - 'name' => 'Group', + 'name' => 'OriginInstanceAddress', 'in' => 'query', - 'schema' => [ - 'description' => 'Group type.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HALVIE_MICRO_GROUP', - ], + 'schema' => ['description' => 'Source instance node address.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1:8848', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'OriginInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace ID. Default is public.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0e9d849b-****-8435da6c21ad', - ], + 'schema' => ['description' => 'Source instance name.', 'type' => 'string', 'required' => false, 'example' => 'Source cluster', 'title' => ''], ], [ - 'name' => 'Beta', + 'name' => 'OriginInstanceNamespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether it is a Beta release. Default is false.'."\n" - ."\n" - .'- `true`: Yes'."\n" - .'- `false`: No', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Namespace list, required when the source cluster is Nacos.', 'type' => 'string', 'required' => false, 'example' => 'namesapceId1,namesapceId2', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'TargetInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Target instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-ud82*****', 'title' => ''], + ], + [ + 'name' => 'TargetClusterName', + 'in' => 'query', + 'schema' => ['description' => 'Target instance name.', 'type' => 'string', 'required' => false, 'example' => 'Target cluster', 'title' => ''], + ], + [ + 'name' => 'TargetClusterUrl', + 'in' => 'query', + 'schema' => ['description' => 'Target instance URL.', 'type' => 'string', 'required' => false, 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', 'title' => ''], + ], + [ + 'name' => 'ProjectDesc', + 'in' => 'query', + 'schema' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => 'This is a description.', 'title' => ''], + ], + [ + 'name' => 'SyncType', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'Language type of the returned information:'."\n" - ."\n" - .'- zh: Chinese'."\n" - .'- en: English', + 'description' => 'SyncType', 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'enumValueTitles' => ['All' => 'All', 'Config' => 'Config', 'Service' => 'Service'], + 'example' => 'Service', + 'title' => '', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ @@ -4012,88 +2664,77 @@ 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP status code.', - 'type' => 'string', - 'example' => '202', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84', - ], - 'Message' => [ - 'description' => 'Message.', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'Return code.', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Request result, with the following values: - `true`: The request was successful. - `false`: The request failed.', - 'type' => 'boolean', - 'example' => 'true', + 'Data' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'UserId' => ['description' => 'User ID.', 'type' => 'string', 'example' => '183876217*****', 'title' => ''], + 'ClusterType' => ['description' => 'Cluster type.'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], + 'OriginInstanceAddress' => ['description' => 'Source instance node address.', 'type' => 'string', 'example' => '192.168.1.1:8848'."\n", 'title' => ''], + 'OriginInstanceName' => ['description' => 'Source instance name.', 'type' => 'string', 'example' => 'Source cluster', 'title' => ''], + 'OriginInstanceNamespace' => ['description' => 'Namespace list, required when the source cluster is Nacos.', 'type' => 'string', 'example' => 'namesapceId1,namesapceId2', 'title' => ''], + 'TargetInstanceId' => ['description' => 'Target instance ID.', 'type' => 'string', 'example' => 'mse-cn-7pp2w*****', 'title' => ''], + 'TargetClusterName' => ['description' => 'Target instance name.', 'type' => 'string', 'example' => 'Target cluster', 'title' => ''], + 'TargetClusterUrl' => ['description' => 'Target instance URL.', 'type' => 'string', 'example' => 'mse-94d****-nacos-ans.mse.aliyuncs.com:8848', 'title' => ''], + 'ProjectDesc' => ['description' => 'Description.', 'type' => 'string', 'example' => 'testsdfsdfsd', 'title' => ''], + 'SyncType' => ['description' => 'SyncType', 'type' => 'string', 'example' => 'Service', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', 'title' => ''], + 'Message' => ['description' => 'Message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": \\"12\\",\\n \\"UserId\\": \\"183876217*****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.1.1:8848\\\\n\\",\\n \\"OriginInstanceName\\": \\"Source cluster\\",\\n \\"OriginInstanceNamespace\\": \\"namesapceId1,namesapceId2\\",\\n \\"TargetInstanceId\\": \\"mse-cn-7pp2w*****\\",\\n \\"TargetClusterName\\": \\"Target cluster\\",\\n \\"TargetClusterUrl\\": \\"mse-94d****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"testsdfsdfsd\\",\\n \\"SyncType\\": \\"Service\\"\\n },\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AddMigrationTask', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'Delete Nacos Configuration', - 'description' => '> The current OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', 'translator' => 'machine', ], - 'DeleteNacosConfigs' => [ - 'summary' => 'Deletes multiple Nacos configurations at a time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddMockRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4101,153 +2742,173 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17012', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-i7m2e32pd0n', - ], + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent-auto-test-sc', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20024,20025,20026,20027,20034,20104,20394', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1ef93a21-3487-4367-a859-857d8****', - ], + 'schema' => ['description' => 'The source of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'edasmsc', 'title' => ''], + ], + [ + 'name' => 'ProviderAppId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the provider application.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dcqtkuhnc4@66e5235415****', 'title' => ''], + ], + [ + 'name' => 'ProviderAppName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the provider application.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'demo-cartservice', 'title' => ''], + ], + [ + 'name' => 'ExtraJson', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'ScMockItems', + 'in' => 'query', + 'schema' => ['description' => 'The input parameters. The value must be a JSON string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[]', 'title' => ''], + ], + [ + 'name' => 'DubboMockItems', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the project in the recycle bin.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[]', 'title' => ''], + ], + [ + 'name' => 'ConsumerAppIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the custom application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{\\"appName\\":\\"provide\\",\\"appId\\":\\"bst8l6o735@f6d8aaf6e56e67d\\"}]', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the mock rule. Valid values:'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'MockType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the response time (RT) of a slow call. Valid values:'."\n" + ."\n" + .'- 15: 15 ms'."\n" + ."\n" + .'- 30: 30 ms'."\n" + ."\n" + .'- 60: 60 ms'."\n" + ."\n" + .'- 120: 120 ms', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '73EB5563-CBB3-5F48-999D-512F4EFB7377', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Data' => [ + 'description' => 'Data Overview.', + 'type' => 'object', + 'properties' => [ + 'NamespaceId' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'ScMockItemJson' => ['description' => 'The mock rule for the HTTP protocol.', 'type' => 'string', 'example' => '[{"oper":"return+json","Path":"/mock","Value":"{\\n \\"date\\": \\"2021-09-10T07:45:12.357+0000\\",\\n \\"name\\": \\"name\\",\\n \\"id\\": \\"1\\"\\n}","Method":"GET","Condition":"AND","Timeout":1,"ArgumentMockItems":[{"type":"param","name":"id","value":"1","cond":"==","operator":"rawvalue"},{"type":"param","name":"name","value":"aliyun","cond":"==","operator":"rawvalue"}]}]', 'title' => ''], + 'ConsumerAppName' => ['description' => 'The name of the application to query.', 'type' => 'string', 'example' => 'demo-xxxx', 'title' => ''], + 'ConsumerAppId' => ['description' => 'The ID of the consumer application.', 'type' => 'string', 'example' => 'hkhon1po62@a000601b265xxxx', 'title' => ''], + 'AccountId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '178432728867xxxx', 'title' => ''], + 'ExtraJson' => ['description' => 'The description.', 'type' => 'string', 'example' => 'desc', 'title' => ''], + 'Source' => ['description' => 'The source.', 'type' => 'string', 'example' => 'edasmsc', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'ProviderAppId' => ['description' => 'The ID of the provider application.', 'type' => 'string', 'example' => 'hkhon1po62@a000601b265xxxx', 'title' => ''], + 'ProviderAppName' => ['description' => 'The name of the provider application.', 'type' => 'string', 'example' => 'demo-xxxx', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', 'title' => ''], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '275', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MockType' => ['description' => 'The model type. Valid values:'."\n" + ."\n" + .'- `0`: desktop model.'."\n" + ."\n" + .'- `1`: mobile model.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Succ\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": {\\n \\"NamespaceId\\": \\"cn-shanghai\\",\\n \\"ScMockItemJson\\": \\"[{\\\\\\"oper\\\\\\":\\\\\\"return+json\\\\\\",\\\\\\"Path\\\\\\":\\\\\\"/mock\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"{\\\\\\\\n \\\\\\\\\\\\\\"date\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"2021-09-10T07:45:12.357+0000\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"\\\\\\\\n}\\\\\\",\\\\\\"Method\\\\\\":\\\\\\"GET\\\\\\",\\\\\\"Condition\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"Timeout\\\\\\":1,\\\\\\"ArgumentMockItems\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"param\\\\\\",\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\",\\\\\\"cond\\\\\\":\\\\\\"==\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"rawvalue\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"param\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name\\\\\\",\\\\\\"value\\\\\\":\\\\\\"aliyun\\\\\\",\\\\\\"cond\\\\\\":\\\\\\"==\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"rawvalue\\\\\\"}]}]\\",\\n \\"ConsumerAppName\\": \\"demo-xxxx\\",\\n \\"ConsumerAppId\\": \\"hkhon1po62@a000601b265xxxx\\",\\n \\"AccountId\\": \\"178432728867xxxx\\",\\n \\"ExtraJson\\": \\"desc\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"ProviderAppId\\": \\"hkhon1po62@a000601b265xxxx\\",\\n \\"ProviderAppName\\": \\"demo-xxxx\\",\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\",\\n \\"Id\\": 275,\\n \\"Enable\\": true,\\n \\"MockType\\": 0\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AddMockRule', + 'summary' => 'Creates a mock rule.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:AddMockRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"RequestId\\": \\"73EB5563-CBB3-5F48-999D-512F4EFB7377\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteNacosConfigs', - 'description' => '> The current API operation is not provided in Nacos SDK. For more information about the Nacos-SDK API, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'UpdateNacosConfig' => [ - 'summary' => 'Updates a Nacos configuration.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddSSLCert' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -4256,1748 +2917,1067 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17102', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '35701', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'DomainId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-7pp2a****', - ], + 'schema' => ['description' => 'The domain ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'DataId', + 'name' => 'CertIdentifier', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ky-check-****.yml', - ], + 'schema' => ['description' => 'The ID of the certificate.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5213641-cn-hangzhou'], ], [ - 'name' => 'Group', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'resource', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ - 'name' => 'AppName', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'postoffice', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Tags', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2021-10-20', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E1CC74F0-5BDE-5220-A031-5CA622D80723'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'Indicates whether the association is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Desc', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Basic configurations'."\n", - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1CC74F0-5BDE-5220-A031-5CA622D80723\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'AddSSLCert', + 'summary' => 'Associates a certificate with a domain name of a gateway. You can specify a certificate that is hosted in Alibaba Cloud Security.', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The format of the configuration. Supported formats include TEXT, JSON, XML, and HTML.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'text', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddSSLCert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'AddSecurityGroupRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The content of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'attribute1=1221111\\r\\nattribute2=Chinese\\r\\nattribute3=abc11\\r\\nattribute4=1.00111'."\n", - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'NamespaceId', + 'name' => 'SecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '78b7af66-d15f-4541-b886-11ed81ecb6c0', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the security group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sg-wz929kxhcdpw9z8idqd8'], ], [ - 'name' => 'Md5', + 'name' => 'PortRange', 'in' => 'query', - 'schema' => [ - 'description' => 'The MD5 value of the configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '045439703a273a94306422b****', - ], + 'schema' => ['title' => '', 'description' => 'The range of port numbers.'."\n", 'type' => 'string', 'required' => true, 'example' => '1/65535'], ], [ - 'name' => 'BetaIps', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of IP addresses where the beta release of the configuration is performed.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '196.168.XX.XX', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], ], [ - 'name' => 'EncryptedDataKey', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The encryption key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '122wdwe****', - ], + 'schema' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '12'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Nacos.Intercepted', - 'errorMessage' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"12\\"\\n}","type":"json"}]', + 'title' => 'AddSecurityGroupRule', + 'summary' => 'Creates a security group rule for a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateNacosConfig', - 'description' => '> The current API operation is not provided in Nacos SDK. For more information about Nacos SDK, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'ListListenersByConfig' => [ - 'summary' => 'Queries listeners based on configuration information.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddServiceSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17070', - 'abilityTreeNodes' => [ - 'FEATUREmseHU6B10', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\\\"appGroup\\\\":\\\\"emas-zfive_prehost\\\\",\\\\"appName\\\\":\\\\"emas-zfive\\\\",\\\\"appStage\\\\":\\\\"PRE_PUBLISH\\\\",\\\\"appUnit\\\\":\\\\"\\\\",\\\\"bucId\\\\":\\\\"225902\\\\",\\\\"bucName\\\\":\\\\"Wireless\\\\",\\\\"provider\\\\":\\\\"aliyun\\\\"}'."\n", - ], + 'schema' => ['description' => 'The type of the service source.'."\n" + ."\n" + .'* K8s: Container Service for Kubernetes (ACK) cluster'."\n" + .'* NACOS: Nacos instance', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'The Ingress configuration.'."\n"], ], [ - 'name' => 'InstanceId', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-m7r1yurp00e', - ], + 'schema' => ['description' => 'The service source.'."\n" + ."\n" + .'* K8s: ACK cluster'."\n" + .'* NACOS: MSE Nacos instance', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'K8s,MSE'], ], [ - 'name' => 'DataId', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zeekr-clueboss.yml', - ], + 'schema' => ['description' => 'Specifies whether to monitor Ingress classes.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'c9ad2a0717032427e920754e25b49e3b5'], ], [ - 'name' => 'Group', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => 'The namespace whose resources you want to monitor.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'istio'], ], [ - 'name' => 'NamespaceId', + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to update the Ingress status.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], + ], + [ + 'name' => 'IngressOptionsRequest', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', + 'description' => 'The list of service groups.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => ['description' => 'The group to which the service belongs.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'IngressClass' => ['description' => 'An array of service root paths.'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.test.xxx'], + 'WatchNamespace' => ['description' => 'The root path of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + 'EnableStatus' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese. This is the default value.'."\n" + .'* en-US: English.'."\n" + .'* ja: Japanese.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'docRequired' => false, - 'example' => 'aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1', ], ], [ - 'name' => 'ExtGrayRules', + 'name' => 'ToAuthorizeSecurityGroups', 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => 'The list of security groups to be authorized. You can specify security groups to allow backend services to access data sources that you create.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GrayRuleType' => [ - 'type' => 'string', - 'enum' => [ - 'Tags', - 'Beta', - ], - ], - 'GrayRuleName' => [ - 'type' => 'string', - ], - 'GrayRule' => [ - 'type' => 'string', - ], - 'GrayRulePriority' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'SecurityGroupId' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-bp1acepclex0vmi1****'], + 'PortRange' => ['description' => 'The authorized port range of the security group. You can select multiple port ranges. Separate each port range with a comma (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '8080/8080,9000/10000'], + 'Description' => ['description' => 'The description of the authorization record.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rule for xxx'], ], + 'required' => false, ], + 'required' => false, ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'GroupList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'NACOS'], + 'required' => false, + ], + ], + [ + 'name' => 'PathList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'required' => false, 'example' => '/test'], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh-CN (default): Chinese'."\n" + .'* en-US: English'."\n" + .'* ja: Japanese'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Listeners' => [ - 'description' => 'The information about listeners.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Ip' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'Md5' => [ - 'description' => 'The verification string.'."\n", - 'type' => 'string', - 'example' => '23sdfdf', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'beta', - ], - 'Labels' => [ - 'description' => 'The label of the listener.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The key-value pairs of the label.'."\n", - ], - ], - 'Version' => [ - 'description' => 'The current version of the listener. Valid values: gray and normal.'."\n", - 'type' => 'string', - 'example' => 'gray', - ], - 'MatchRuleName' => [ - 'title' => '当前Listener匹配的灰度规则名称', - 'type' => 'string', - ], - 'MatchRuleType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '75E1442F-11EC-567A-9CF0-5A36F7904F39', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The response data.'."\n", 'type' => 'string', 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA'], + 'HttpStatusCode' => ['description' => 'code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'mse-200-105', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7'], + 'Code' => ['description' => 'duplicatedClusterAliasName', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'duplicated cluster alias name', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'mse-100-007', 'type' => 'integer', 'format' => 'int64', 'example' => '63'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 63\\n}","type":"json"}]', + 'title' => 'AddServiceSource', + 'summary' => 'Adds a Nacos service source.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"Listeners\\": [\\n {\\n \\"Ip\\": \\"1.1.1.1\\",\\n \\"Md5\\": \\"23sdfdf\\",\\n \\"Status\\": \\"true\\",\\n \\"Labels\\": {\\n \\"key\\": \\"a=b\\"\\n },\\n \\"Version\\": \\"gray\\",\\n \\"MatchRuleName\\": \\"匹配到的灰度规则的名称\\",\\n \\"MatchRuleType\\": \\"Beta\\"\\n }\\n ],\\n \\"RequestId\\": \\"75E1442F-11EC-567A-9CF0-5A36F7904F39\\",\\n \\"Message\\": \\"success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 2,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListListenersByConfig', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'ListListenersByIp' => [ - 'summary' => 'Queries the information about listeners based on IP addresses.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddZooKeeperSaslUser' => [ + 'summary' => 'Adds a ZooKeeper SASL user.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17071', - 'abilityTreeNodes' => [ - 'FEATUREmseHU6B10', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217281', + 'abilityTreeNodes' => ['FEATUREmse2TF2YB'], ], 'parameters' => [ - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-i7m2cecji09', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'Ip', + 'name' => 'SaslUser', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The IP address of the listener.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'user'], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'traaqwrasdf'], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'maxLength' => 128, 'title' => '', 'required' => false, 'example' => 'description'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => '172.22.0.240', - ], - ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ea02a522-9482-4255-bb65-dc0636d783f2', + 'title' => '', + 'description' => 'The SASL users to add.', + 'example' => '', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Reload', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Specifies whether to immediately restart the cluster to apply the changes.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Listeners' => [ - 'description' => 'The information about listeners.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Md5' => [ - 'description' => 'The verification string.'."\n", - 'type' => 'string', - 'example' => '23sdfdf', - ], - 'DataId' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'NamespaceId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'MSE-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', 'title' => ''], + 'Data' => ['description' => 'The result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => 'RestResult', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddZooKeeperSaslUser', + 'changeSet' => [], + 'ramActions' => [ [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 6,\\n \\"Listeners\\": [\\n {\\n \\"Md5\\": \\"23sdfdf\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"default\\",\\n \\"NamespaceId\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"MSE-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListListenersByIp', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'GetNacosConfig' => [ - 'summary' => 'Get Nacos Configuration', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ApplyGatewayRoute' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17035', - 'abilityTreeNodes' => [ - 'FEATUREmseEUE1FY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '28369', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-i7m2h0****', - ], - ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Data ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'halvie-mp-item****', - ], - ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration group information.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'common', - ], - ], - [ - 'name' => 'NamespaceId', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace ID.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', - ], + 'schema' => ['description' => 'The ID of the route.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '950'], ], [ - 'name' => 'Beta', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether it is a Beta release.'."\n" - ."\n" - .'- `true`: Yes'."\n" - .'- `false`: No', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'Language type of the returned information:'."\n" - ."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Data structure.', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'Message.', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD', - ], - 'Configuration' => [ - 'description' => 'Configuration information.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Format of the configuration content.', - 'type' => 'string', - 'example' => 'text', - ], - 'AppName' => [ - 'description' => 'Application name.', - 'type' => 'string', - 'example' => 'test', - ], - 'Tags' => [ - 'description' => 'Tags of the configuration.', - 'type' => 'string', - 'example' => 'context', - ], - 'Md5' => [ - 'description' => 'Message digest of the configuration.', - 'type' => 'string', - 'example' => '123rfsdf3', - ], - 'DataId' => [ - 'description' => 'Configuration ID.', - 'type' => 'string', - 'example' => 'log.yaml', - ], - 'Content' => [ - 'description' => 'Configuration content.', - 'type' => 'string', - 'example' => 'log.level=error', - ], - 'Group' => [ - 'description' => 'Configuration group name.', - 'type' => 'string', - 'example' => 'test', - ], - 'Desc' => [ - 'description' => 'Configuration description.', - 'type' => 'string', - 'example' => 'For testing'."\n", - ], - 'EncryptedDataKey' => [ - 'description' => 'Encrypted key.', - 'type' => 'string', - 'example' => 'key', - ], - 'BetaIps' => [ - 'description' => 'List of IPs for Beta release.', - 'type' => 'string', - 'example' => '1.1.XX.XX，2.2.XX.XX', - ], - 'GrayVersions' => [ - 'title' => '当前配置的灰度版本信息', - 'description' => 'Current gray version information', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '灰度类型', - 'description' => 'Gray type', - 'type' => 'string', - 'example' => 'Beta', - ], - 'Name' => [ - 'title' => '灰度版本名称', - 'description' => 'Gray version name', - 'type' => 'string', - 'example' => 'test', - ], - 'Rule' => [ - 'title' => '当前灰度版本的规则', - 'description' => 'Rules of the current gray version', - 'type' => 'string', - 'example' => 'a=b', - ], - 'Priority' => [ - 'title' => '当前灰度规则的优先级', - 'description' => 'The priority of the current gray rule.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'The result of the request, with values as follows:'."\n" - .'- `true`: The request was successful.'."\n" - .'- `false`: The request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1DB1AB36-8395-540E-AACC-7571D6B2057A'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DB1AB36-8395-540E-AACC-7571D6B2057A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'ApplyGatewayRoute', + 'summary' => 'Publishes a route for a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ApplyGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD\\",\\n \\"Configuration\\": {\\n \\"Type\\": \\"text\\",\\n \\"AppName\\": \\"test\\",\\n \\"Tags\\": \\"context\\",\\n \\"Md5\\": \\"123rfsdf3\\",\\n \\"DataId\\": \\"log.yaml\\",\\n \\"Content\\": \\"log.level=error\\",\\n \\"Group\\": \\"test\\",\\n \\"Desc\\": \\"测试专用\\",\\n \\"EncryptedDataKey\\": \\"key\\",\\n \\"BetaIps\\": \\"1.1.XX.XX，2.2.XX.XX\\",\\n \\"GrayVersions\\": [\\n {\\n \\"Type\\": \\"Beta\\",\\n \\"Name\\": \\"test\\",\\n \\"Rule\\": \\"a=b\\",\\n \\"Priority\\": 20\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'Get Nacos Configuration', - 'description' => '> This OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', - 'translator' => 'machine', ], - 'GetNacosHistoryConfig' => [ - 'summary' => 'Queries the historical details of Nacos configuration changes.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ApplyTagPolicies' => [ + 'summary' => 'This operation modifies tag routing rules.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '16993', + 'abilityTreeNodes' => ['FEATUREmseW9QIF2'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-st220g9ka02', - ], - ], - [ - 'name' => 'DataId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'msg-center.main.yaml', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Group', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The MSE namespace of the application.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'example-app', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'Nid', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The version ID of the configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40****', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'deprecated' => true, 'required' => true, 'docRequired' => true, 'example' => 'h5pohqu3gd@xxx', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Rules', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => '', + 'description' => 'The routing rules.', 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Configuration' => [ - 'description' => 'The configuration information.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Md5' => [ - 'description' => 'The MD5 value of the configuration.'."\n", - 'type' => 'string', - 'example' => '23sdf32f****', - ], - 'DataId' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Content' => [ - 'description' => 'The content of the configuration.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Group' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'OpType' => [ - 'description' => 'The configuration type.'."\n", - 'type' => 'string', - 'example' => 'text', - ], - 'EncryptedDataKey' => [ - 'description' => 'The encryption key.'."\n", - 'type' => 'string', - 'example' => '23fds****', - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.', + 'enumValueTitles' => ['Inactive', 'Active', 'Failed'], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + 'Rate' => ['description' => 'The percentage.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Enable' => ['description' => 'Specifies whether to enable the rule.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Tag' => ['description' => 'The environment for the routing rule.', 'type' => 'string', 'required' => false, 'example' => 'gray', 'title' => ''], + 'Name' => ['description' => 'The name of the routing rule.', 'type' => 'string', 'example' => 'gray', 'title' => '', 'required' => false], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'InstanceNum' => ['description' => 'The number of instances.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Rules' => [ + 'title' => '', + 'description' => 'The rule details.', + 'type' => 'object', + 'properties' => [ + 'springcloud' => [ + 'title' => '', + 'description' => 'The Spring Cloud rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'condition' => ['description' => 'The logical operator for the items. Valid values: AND or OR.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'AND'], + 'restItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'datum' => ['description' => 'The value to compare for operators such as \\`rawvalue\\`.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + 'operator' => ['description' => 'The operator. \\`rawvalue\\` indicates a direct comparison. \\`mode\\` indicates a modulo operation. \\`list\\` indicates a whitelist.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rawvalue'], + 'nameList' => [ + 'type' => 'array', + 'items' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], + 'required' => false, + 'description' => 'The field required for the \\`list\\` operator.', + 'title' => '', + 'example' => '', + ], + 'cond' => ['description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '=='], + 'divisor' => ['description' => 'The divisor for the modulo operation. This parameter is required if \\`operator\\` is \\`mod\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'remainder' => ['description' => 'The percentage value for the operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'rate' => ['description' => 'The percentage of traffic to route to the tagged nodes. For example, 20 means 20% of the traffic.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], + 'type' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'value' => ['description' => 'The value.', 'type' => 'any', 'required' => false, 'example' => 'test', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'triggerPolicy' => [ + 'description' => 'The policy type.', + 'enumValueTitles' => ['PERCENT' => 'a percentage-based rule', 'CONTENT' => 'a content-based rule'], + 'type' => 'string', + 'required' => false, + 'example' => 'CONTENT', + 'title' => '', + ], + 'enable' => ['description' => 'Specifies whether the rule is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'appId' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => '***@***', 'title' => ''], + 'priority' => ['description' => 'The priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => ['description' => 'A tag.', 'type' => 'string', 'required' => false, 'example' => 'gray', 'title' => ''], + 'required' => false, + 'description' => 'The list of tags.', + 'title' => '', + 'example' => '', + ], + 'paths' => [ + 'type' => 'array', + 'items' => ['description' => 'A path.', 'type' => 'string', 'required' => false, 'example' => '/hello', 'title' => ''], + 'required' => false, + 'description' => 'The list of paths.', + 'title' => '', + 'example' => '', + ], + 'path' => ['description' => 'The path.', 'type' => 'string', 'required' => false, 'example' => '/hello', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'dubbo' => [ + 'title' => '', + 'description' => 'The Dubbo rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appId' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => '***@***'."\n", 'title' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => ['description' => 'A tag.', 'type' => 'string', 'required' => false, 'example' => 'gray', 'title' => ''], + 'required' => false, + 'description' => 'The list of tags.', + 'title' => '', + 'example' => '', + ], + 'triggerPolicy' => ['description' => 'The policy type.', 'type' => 'string', 'required' => false, 'example' => 'CONTENT', 'title' => ''], + 'serviceName' => ['description' => 'The service name (interface).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'HelloService'], + 'group' => ['description' => 'The group of the Dubbo service.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'default'], + 'version' => ['description' => 'The version of the Dubbo service.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.0.0'], + 'methodName' => ['description' => 'The method name of the Dubbo service.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hello'], + 'paramTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'The parameter type.', 'type' => 'string', 'required' => false, 'example' => 'int', 'title' => ''], + 'required' => false, + 'description' => 'The list of parameter types.', + 'title' => '', + 'example' => '', + ], + 'condition' => ['description' => 'The logical operator for the items. Valid values: AND or OR.', 'type' => 'string', 'example' => 'AND', 'title' => '', 'required' => false], + 'argumentItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'operator' => ['description' => 'The operator. \\`rawvalue\\` indicates a direct comparison. \\`mode\\` indicates a modulo operation. \\`list\\` indicates a whitelist.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rawvalue'], + 'nameList' => [ + 'type' => 'array', + 'items' => ['description' => 'A name.', 'type' => 'string', 'required' => false, 'example' => 'demo', 'title' => ''], + 'required' => false, + 'description' => 'The list of names.', + 'title' => '', + 'example' => '', + ], + 'datum' => ['description' => 'The value to compare for operators such as \\`rawvalue\\`.', 'type' => 'string', 'required' => false, 'example' => '30'."\n", 'title' => ''], + 'cond' => ['description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '=='], + 'divisor' => ['description' => 'The divisor for the modulo operation. This parameter is required if \\`operator\\` is \\`mod\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'."\n", 'title' => ''], + 'remainder' => ['description' => 'The required percentage value for the percentage operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'."\n", 'title' => ''], + 'rate' => ['description' => 'The percentage of traffic to route to the tagged nodes. For example, 20 means 20% of the traffic.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'index' => ['description' => 'The position of the parameter, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], + 'expr' => ['description' => 'The expression.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], + 'value' => ['description' => 'The value to compare. The result of the expression is compared with this value. If \\`operator\\` is \\`list\\`, use a comma (,) to separate multiple values. Example: 1,2,3.', 'type' => 'any', 'title' => '', 'required' => false, 'example' => '1,2,3'], + ], + 'required' => false, + 'description' => 'The argument details.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'description' => 'The list of arguments.', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'The rule content.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '{ "blue": { # Tag key. "rate": 20, # Rate. A value of 20 indicates that 20% of the traffic is routed to the node identified by the tag. "name": "luoye-route-test", # Routing rule name. "carryData": false, # Specifies whether to enable pass-through. This parameter is applicable to end-to-end canary release. "rules": { # Rule information. "dubbo": \\[{ # Dubbo rule. The system also supports Spring Cloud and Istio rule. "serviceName": "com.taobao.hsf.common.DemoService", # Service name (operation name). "group": "", # Group name. "version": "", # Service version. "methodName": "sayHello", # Method name. "condition": "AND", # Logical operator used by the following items. Valid values: AND and OR. "argumentItems": \\[{ # Array of rule details. "index": 0, # Index field. "expr": "", # Expression. Its details is described below. "operator": "rawvalue", # The comparison mode. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist. "value": "jim", # Base value. The value obtained by the expression will be compared with this value. If operator is set to list, separate the items specified for this parameter with commas (,). Example: 1,2,3. "cond": "==" # Comparison operator. Valid values: >=, <=, >, <, and ==. }] }] } }, "\\_base": { # Another tag key. "rate": 80 # Rate. A value of 20 indicates that 20% of the traffic is routed to the node identified by the tag. } }'."\n", + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace. This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => '12233****', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response message:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'InstanceNum' => ['description' => 'The number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Remove' => ['description' => 'Indicates whether the rule was deleted.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'CarryData' => ['description' => 'Indicates whether it is a primary key.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'example' => 'gray', 'title' => ''], + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Rules' => ['description' => 'The tag rule.', 'type' => 'string', 'example' => '{\\"_base\\": {\\"rate\\": 100, \\"remove\\": true}, \\"blue\\": {\\"rate\\": 0}}', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Rate' => ['description' => 'The percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"InstanceNum\\": 1,\\n \\"Remove\\": false,\\n \\"CarryData\\": true,\\n \\"Tag\\": \\"gray\\",\\n \\"Name\\": \\"test\\",\\n \\"Rules\\": \\"{\\\\\\\\\\\\\\"_base\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"rate\\\\\\\\\\\\\\": 100, \\\\\\\\\\\\\\"remove\\\\\\\\\\\\\\": true}, \\\\\\\\\\\\\\"blue\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"rate\\\\\\\\\\\\\\": 0}}\\",\\n \\"Id\\": 12,\\n \\"Rate\\": 10,\\n \\"Enable\\": true\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ApplyTagPolicies', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ApplyTagPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Configuration\\": {\\n \\"AppName\\": \\"test\\",\\n \\"Md5\\": \\"23sdf32f****\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Content\\": \\"test\\",\\n \\"Group\\": \\"public\\",\\n \\"OpType\\": \\"text\\",\\n \\"EncryptedDataKey\\": \\"23fds****\\"\\n },\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetNacosHistoryConfig', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'ListNacosConfigs' => [ - 'summary' => 'Queries Nacos configurations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'BindSentinelBlockFallbackDefinition' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17072', - 'abilityTreeNodes' => [ - 'FEATUREmse8153EN', - ], - 'autoTest' => true, + 'operationType' => 'update', + 'abilityTreeCode' => '164017', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters. The JSON format is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\\\"appGroup\\\\":\\\\"sm_zk_asi_na610\\\\",\\\\"appName\\\\":\\\\"sm-zk\\\\",\\\\"appStage\\\\":\\\\"PUBLISH\\\\",\\\\"appUnit\\\\":\\\\"center\\\\",\\\\"bucId\\\\":\\\\"193554\\\\",\\\\"bucName\\\\":\\\\"Alibaba Mobile Business Group-UC\\\\",\\\\"provider\\\\":\\\\"aliyun\\\\"}'."\n", - 'title' => '参数弃用，无需填写', - ], + 'schema' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'PageNum', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '5', - ], + 'schema' => ['title' => '', 'description' => 'The microservice namespace.', 'type' => 'string', 'required' => true, 'example' => 'prod'], ], [ - 'name' => 'PageSize', + 'name' => 'FallbackId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '200', - ], + 'schema' => ['title' => '', 'description' => 'Behavior ID. 0:the default behavior.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21'], ], [ - 'name' => 'InstanceId', + 'name' => 'TargetType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", + 'title' => '', + 'description' => 'Target rule type.', 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-7mz2fj****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'zeekr-*', - ], - ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group. Default value: `default`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'crm', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'fpx-pds-pns', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'billing', + 'enumValueTitles' => [1 => '', '', 4 => '', 6 => '', 11 => ''], + 'example' => '1', ], ], [ - 'name' => 'NamespaceId', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'fad732a7-ff1a-4f21-8126-4edd4****', - ], + 'schema' => ['title' => '', 'description' => 'Interface Name: The resource to which the rule applies. It must match the interface name in the console\'s interface details.', 'type' => 'string', 'required' => true, 'example' => '/a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4081087F-3429-5873-A1E7-D4B5479D0B84', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Configurations' => [ - 'description' => 'The configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DataId' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'string', - 'example' => 'log.yaml', - ], - 'Id' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => '132****', - ], - 'Group' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'Description' => [ - 'type' => 'string', - ], - 'ConfigTags' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'OperationNotSupport', - 'errorMessage' => 'The current cluster does not support this operation, %s.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'BindSentinelBlockFallbackDefinition', + 'summary' => 'Binds traffic protection behavior.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:BindSentinelBlockFallbackDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceApplication', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}/application/{#AppName}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"4081087F-3429-5873-A1E7-D4B5479D0B84\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Configurations\\": [\\n {\\n \\"AppName\\": \\"test\\",\\n \\"DataId\\": \\"log.yaml\\",\\n \\"Id\\": \\"132****\\",\\n \\"Group\\": \\"public\\",\\n \\"Description\\": \\"\\",\\n \\"ConfigTags\\": \\"\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListNacosConfigs', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'ListNacosHistoryConfigs' => [ - 'summary' => 'Queries the configuration history of a Microservices Engine (MSE) Nacos instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ChangeResourceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['common'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17073', - 'abilityTreeNodes' => [ - 'FEATUREmseEUE1FY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '150111', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\\\"appGroup\\\\":\\\\"aliyun-phecda-service-staging\\\\",\\\\"appName\\\\":\\\\"aliyun-phecda-service\\\\",\\\\"appStage\\\\":\\\\"DAILY\\\\",\\\\"appUnit\\\\":\\\\"center\\\\",\\\\"bucId\\\\":\\\\"250858\\\\",\\\\"bucName\\\\":\\\\"Alibaba Cloud\\\\",\\\\"provider\\\\":\\\\"aliyun\\\\"}'."\n", - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-2r42e3bk20n', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '资源类型', 'description' => 'Resource type, such as a registration and configuration center cluster or gateway instance', 'type' => 'string', 'required' => false, 'example' => 'Cluster,Gateway', 'default' => 'Cluster'], ], [ - 'name' => 'DataId', + 'name' => 'ResourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'user-prod.yaml', - ], + 'schema' => ['title' => '资源Id', 'description' => 'Resource ID, which is the ID of the registration and configuration center instance or the unique ID of the gateway', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-xxxxxxxxxxx，'."\n" + .'gw-xxxxxxxxxxxxxxxxxxxx'], ], [ - 'name' => 'Group', + 'name' => 'ResourceRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'fc-dev-cluster-1', - ], + 'schema' => ['title' => '地域Id', 'description' => 'Region ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NamespaceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'fc0f6e40-****-946b-45e3af313707', - ], + 'schema' => ['title' => '目标资源组', 'description' => 'Target resource group', 'type' => 'string', 'required' => true, 'example' => 'rg-acfm34x43l*****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => 'The language in which the response is displayed. Values: zh (default): Chinese, en: English', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Response Schema', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '53338ECA-F880-54D8-A9B3-5606355A1B89', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HistoryItems' => [ - 'description' => 'The configuration items.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The application tag.'."\n", - 'type' => 'string', - 'example' => 'gateway', - ], - 'DataId' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'LastModifiedTime' => [ - 'description' => 'The timestamp when the configuration was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16434400', - ], - 'Id' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23fdsf', - ], - 'OpType' => [ - 'description' => 'The format of the configuration file.'."\n", - 'type' => 'string', - 'example' => 'yaml', - ], - 'SrcUser' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\"\\n}","type":"json"}]', + 'title' => 'Change the Resource Group of an Instance', + 'summary' => 'Resource Transfer', + 'translator' => 'machine', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"53338ECA-F880-54D8-A9B3-5606355A1B89\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HistoryItems\\": [\\n {\\n \\"AppName\\": \\"gateway\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"default\\",\\n \\"LastModifiedTime\\": 1643440066000,\\n \\"Id\\": 0,\\n \\"OpType\\": \\"yaml\\",\\n \\"SrcUser\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListNacosHistoryConfigs', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], 'CloneNacosConfig' => [ - 'summary' => 'Copy Nacos Configuration', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'summary' => 'Clones existing Nacos configurations to another namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -6008,436 +3988,224 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '76154', - 'abilityTreeNodes' => [ - 'FEATUREmseYJ44D3', - ], + 'abilityTreeNodes' => ['FEATUREmseYJ44D3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-i7m25igg403', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-i7m25igg403', 'title' => ''], ], [ 'name' => 'OriginNamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Source namespace ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'be821963-6d48-4ea5-9910-6057d****', - ], + 'schema' => ['description' => 'The source namespace ID.', 'type' => 'string', 'required' => false, 'example' => 'be821963-6d48-4ea5-9910-6057d****', 'title' => ''], ], [ 'name' => 'TargetNamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Target namespace ID.', - 'type' => 'string', - 'required' => false, - 'example' => '08be4b5d-2d1c-4e6e-aa85-83b9****', - ], + 'schema' => ['description' => 'The destination namespace ID.', 'type' => 'string', 'required' => false, 'example' => '08be4b5d-2d1c-4e6e-aa85-83b9****', 'title' => ''], ], [ 'name' => 'Policy', 'in' => 'query', 'schema' => [ - 'description' => 'The strategy used when a write conflict occurs.'."\n" + 'description' => 'The policy used when a write conflict occurs. Valid values:'."\n" ."\n" .'- ABORT'."\n" .'- SKIP'."\n" - .'- OVERWRITE', + .'- OVERWRITE.', + 'enumValueTitles' => ['ABORT' => 'Abort.', 'OVERWRITE' => 'Overwrite.', 'SKIP' => 'Skip.'], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'enumValueTitles' => [ - 'ABORT' => '终止', - 'OVERWRITE' => '覆盖', - 'SKIP' => '跳过', - ], 'example' => 'OVERWRITE', + 'title' => '', ], ], [ 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => 'List of configuration IDs.', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => '253661,253662', - ], + 'schema' => ['description' => 'The list of configuration IDs.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => '253661,253662', 'title' => ''], ], [ 'name' => 'DataIds', 'in' => 'query', - 'schema' => [ - 'title' => '需要克隆的配置项，格式为 dataId+group，多个配置项使用 , 分隔', - 'description' => 'Configuration items to be cloned, in the format of dataId+group, with multiple items separated by commas.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test+test,test1+test1', - ], + 'schema' => ['title' => '', 'description' => 'The configuration items to clone, in the format of dataId+group. Separate multiple configuration items with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test+test,test1+test1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'Language type of the returned message:'."\n" - ."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Data structure.', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '6678DBA9-5600-5948-ACF8-ED3105B288A3', - ], - 'Success' => [ - 'description' => 'Request result, with the following values:'."\n" - .'- `true`: Request succeeded.'."\n" - .'- `false`: Request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'Response code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Response message.', - 'type' => 'string', - 'example' => 'Clone Completed Successfully', - ], - 'DynamicMessage' => [ - 'description' => 'Dynamic error message, used to replace the **%s** in the **ErrMessage** error message.'."\n" - .'> If **ErrMessage** returns **The Value of Input Parameter %s is not valid**, and **DynamicMessage** returns **DtsJobId**, it indicates that the input request parameter **DtsJobId** is invalid.', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6678DBA9-5600-5948-ACF8-ED3105B288A3', 'title' => ''], + 'Success' => ['description' => 'The request result. Valid values:'."\n" + .'- `true`: The request was successful.'."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Clone Completed Successfully', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic error message, which is used to replace the **%s** placeholder in the **ErrMessage** error message.'."\n" + .'> If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => 'Data overview.', + 'description' => 'The data overview.', 'type' => 'object', 'properties' => [ - 'SuccCount' => [ - 'description' => 'Number of successes.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SkipCount' => [ - 'description' => 'Number of skips.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'SuccCount' => ['description' => 'The number of successful configurations.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'SkipCount' => ['description' => 'The number of skipped configurations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SkipData' => [ - 'description' => 'Skipped configuration information.', + 'description' => 'The skipped configuration information.', 'type' => 'array', 'items' => [ - 'description' => 'Data structure.', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'DataId' => [ - 'description' => 'Data ID.', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'example' => 'public ', - ], + 'DataId' => ['description' => 'The data ID.', 'type' => 'string', 'example' => 'test.yaml', 'title' => ''], + 'Group' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'public ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'FailData' => [ - 'description' => 'Failed configuration information.', + 'description' => 'The failed configuration information.', 'type' => 'array', 'items' => [ - 'description' => '数据结构。', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'DataId' => [ - 'description' => 'Data ID.', - 'type' => 'string', - 'example' => 'test2.yaml', - ], - 'Group' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'example' => 'test', - ], - 'Reason' => [ - 'description' => 'The reason for the current operation.', - 'type' => 'string', - 'example' => 'param not support', - ], + 'DataId' => ['description' => 'The data ID.', 'type' => 'string', 'example' => 'test2.yaml', 'title' => ''], + 'Group' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'The current import configuration format is invalid.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"6678DBA9-5600-5948-ACF8-ED3105B288A3\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Clone Completed Successfully\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"SuccCount\\": 100,\\n \\"SkipCount\\": 1,\\n \\"SkipData\\": [\\n {\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"public \\"\\n }\\n ],\\n \\"FailData\\": [\\n {\\n \\"DataId\\": \\"test2.yaml\\",\\n \\"Group\\": \\"test\\",\\n \\"Reason\\": \\"The current import configuration format is invalid.\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Clone nacos configurations', + 'description' => '> The current OpenAPI is not a Nacos-SDK API. For information about Nacos-SDK APIs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"6678DBA9-5600-5948-ACF8-ED3105B288A3\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Clone Completed Successfully\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"SuccCount\\": 100,\\n \\"SkipCount\\": 1,\\n \\"SkipData\\": [\\n {\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"public \\"\\n }\\n ],\\n \\"FailData\\": [\\n {\\n \\"DataId\\": \\"test2.yaml\\",\\n \\"Group\\": \\"test\\",\\n \\"Reason\\": \\"当前导入配置格式非法\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'CloneNacosConfig', - 'description' => '> This OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', - 'translator' => 'machine', ], - 'ExportNacosConfig' => [ - 'summary' => 'Exports specified Nacos configurations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CloneSentinelRuleFromAhas' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '76155', - 'abilityTreeNodes' => [ - 'FEATUREmse8153EN', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '209225', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-2r42ddc****', - ], - ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ae77c258-4d4f-478f-baaa-084aee0****', - ], - ], - [ - 'name' => 'Ids', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the primary key of a configuration item.'."\n" - ."\n" - .'> - Multiple export methods are supported. You must specify this parameter if you want to export multiple configurations. - You can obtain the value of this parameter by calling the ListNacosConfigs operation. - If you specify this parameter, multiple configurations are exported. The DataId and Group parameters are invalid.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '1709,1710', - ], + 'schema' => ['title' => '', 'description' => 'The namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'DataId', + 'name' => 'MseAppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data that you want to export.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Multiple export methods are supported.'."\n" - ."\n" - .'* If you want to export a single configuration, you must leave the Ids parameter empty and specify the DataID and Group parameters.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => 'sms-mes-develop.prop****', - ], + 'schema' => ['description' => 'The name of the MSE application after migration. If this parameter is not specified, the name of the Application High Availability Service (AHAS) application is used by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'Group', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'TIMEDTASK_COMMON_GROUP', - ], + 'schema' => ['title' => '', 'description' => 'The application name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'AppName', + 'name' => 'AhasNamespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The application tag.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'qjl-gateway-openapi', - ], + 'schema' => ['title' => '', 'description' => 'The namespace (environment) of Application High Availability Service (AHAS).'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'DataIds', + 'name' => 'IsAHASPublicRegion', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration group name and the ID of the configuration that you want to export. Separate multiple configurations with comma (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testGroup+testDataId1,testGroup+testDataId2', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether AHAS is deployed in the Internet region.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>>', + 'description' => 'RestResult\\>'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '92245803-49B7-54CF-8D49-01A34A0E1CD6', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace **%s** in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'title' => '', + 'description' => 'The returned data.'."\n", 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => 'The URL that is used to download the exported configurations.'."\n", - 'type' => 'string', - 'example' => 'http://xxxxxxxxx', - ], + 'additionalProperties' => [ + 'title' => '', + 'description' => 'The execution result.'."\n", + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => '"Finish AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b ..."'."\n", 'description' => 'The execution result details.'."\n"], ], ], ], @@ -6446,900 +4214,829 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Data\\": {\\n \\"key\\": [\\n \\"\\\\\\"Finish AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b ...\\\\\\"\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'CloneSentinelRuleFromAhas', + 'summary' => 'Clones rules from Application High Availability Service.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneSentinelRuleFromAhas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"92245803-49B7-54CF-8D49-01A34A0E1CD6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\"\\n }\\n}","type":"json"}]', - 'title' => 'ExportNacosConfig', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'GetImportFileUrl' => [ - 'summary' => 'Obtains the URL that is used to upload a configuration file when you import the configuration file into a Microservices Engine (MSE) Nacos instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateApplication' => [ + 'summary' => 'Creates an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '76156', - 'abilityTreeNodes' => [ - 'FEATUREmseEPOTV0', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '17001', + 'abilityTreeNodes' => ['FEATUREmse3O985H'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ContentType', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The file type.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'application/zip', - ], + 'schema' => ['description' => 'The region to which the application belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-7pp2b****', - ], + 'schema' => ['title' => '应用所属的MSE命名空间。', 'description' => 'The MSE namespace name.', 'type' => 'string', 'docRequired' => true, 'example' => 'prod', 'maxLength' => 64, 'required' => true], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppName', 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The service where the application is deployed. The value ACK indicates Container Service for Kubernetes.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => 'edasmsc', 'example' => 'ACK', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The programming language of the application.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'JAVA', 'default' => 'JAVA', 'title' => ''], + ], + [ + 'name' => 'SentinelEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to enable the Sentinel component.', 'type' => 'string', 'example' => 'true', 'default' => 'false', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to start the switch.', 'type' => 'string', 'example' => 'true', 'default' => 'false', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the namespace.', - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The custom tag key. The key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'tagKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. The value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'tagKey', 'title' => ''], + ], + 'description' => 'The Alibaba Cloud tag.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'minItems' => 0, + 'description' => 'Alibaba Cloud tags.', 'required' => false, - 'example' => '12788f73-9848-4388-98f1-507778f2****', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '19488A00-4AF5-55E1-A689-98BA9F5E7441', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - .'* `true`: The request was successful. '."\n" - .'* `false`: The request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The error code returned if the request failed.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.', - 'type' => 'string', - 'example' => 'The request was successfully processed.', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\\\*\\\\*%s\\\\*\\\\* variable in the **ErrMessage** parameter.\\n\\n> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Message' => ['description' => 'The message that is returned for the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '68D91223-CCE9-5F9C-B538-20F617DA48B1', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.', + 'description' => 'The node data.', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'The URL that is used to upload the configuration file.', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], + 'Status' => ['description' => 'The application status. The value 1 indicates normal.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ExtraInfo' => ['description' => 'The additional information.', 'type' => 'string', 'example' => '{\\"rpcTypes\\":[\\"dubbo\\",\\"springCloud\\"]}', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the application was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663', 'title' => ''], + 'LicenseKey' => ['description' => 'The license key of the user.', 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the application was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx', 'title' => ''], + 'UserId' => ['description' => 'The Alibaba Cloud user ID.', 'type' => 'string', 'example' => '1888888888', 'title' => ''], + 'Source' => ['description' => 'The service where the application is deployed. Valid values:'."\n" + ."\n" + .'- ACK: Container Service for Kubernetes.'."\n" + ."\n" + .'- Normal: another service', 'type' => 'string', 'example' => 'ACK', 'title' => ''], + 'Language' => ['description' => 'The programming language of the application.', 'type' => 'string', 'example' => 'JAVA', 'title' => ''], + 'RegionId' => ['description' => 'The region of the gateway.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The MSE namespace name.', 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'Version' => ['description' => 'The version number.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], ], + 'example' => 'data', + 'title' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"68D91223-CCE9-5F9C-B538-20F617DA48B1\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"ExtraInfo\\": \\"{\\\\\\\\\\\\\\"rpcTypes\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dubbo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"springCloud\\\\\\\\\\\\\\"]}\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"UpdateTime\\": 1632979237663,\\n \\"LicenseKey\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"CreateTime\\": 1631001140913,\\n \\"AppId\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"UserId\\": \\"1888888888\\",\\n \\"Source\\": \\"ACK\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"prod\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'CreateApplication', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"19488A00-4AF5-55E1-A689-98BA9F5E7441\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxx\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetImportFileUrl', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).\\n', ], - 'ImportNacosConfig' => [ - 'summary' => 'Imports Nacos configurations as a file.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateCircuitBreakerRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '76157', - 'abilityTreeNodes' => [ - 'FEATUREmseEPOTV0', - ], + 'abilityTreeCode' => '167810', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-****', - ], + 'schema' => ['title' => '', 'description' => 'The microservice namespace to which the application belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'f5cdc80a-****-8094-282f5650fc00', - ], + 'schema' => ['title' => '', 'description' => 'The application name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'Policy', + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '0.8'], + ], + [ + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'The policy.'."\n" + 'title' => '', + 'description' => 'Specifies whether to enable the rule.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* ABORT'."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" ."\n" .' '."\n" ."\n" + .'* false'."\n" + ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .'* OVERWRITE'."\n" + .' '."\n", + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the interface to which the rule applies. The interface name must be the same as the name on the interface details page in the console.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/a'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region in which the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" ."\n" .' '."\n" ."\n" + .' :'."\n" + ."\n" .' '."\n" ."\n" + .' slow call proportion'."\n" + ."\n" .' '."\n" ."\n" - .'* SKIP'."\n" + .'* 1'."\n" ."\n" .' '."\n" ."\n" + .' :'."\n" + ."\n" .' '."\n" ."\n" + .' abnormal proportion'."\n" + ."\n" .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ABORT' => 'ABORT', - 'OVERWRITE' => 'OVERWRITE', - 'SKIP' => 'SKIP', - ], - 'example' => 'overwrite', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => ['', ''], + 'example' => '0', ], ], [ - 'name' => 'FileUrl', + 'name' => 'RetryTimeoutMs', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'http://mse-shared.oss-xxx.aliyuncs.com/cfg/import/xxxx/2021/01/11/xxxx.zip', - ], + 'schema' => ['title' => '', 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period. The value must be an integral multiple of 1,000. Default value: 10000. This value indicates 10 seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes. The default value is 20000. This value indicates 20 seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000'], + ], + [ + 'name' => 'MaxAllowedRtMs', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'HalfOpenBaseAmountPerStep', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'HalfOpenRecoveryStepNum', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of circuit breaking recovery steps. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" + 'description' => 'The resource type.'."\n" ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + .'Valid values:'."\n" + ."\n" + .'* 0: custom interface'."\n" + .'* 1: web'."\n" + .'* 2: RPC'."\n" + .'* 3: route'."\n" + .'* 4: SQL'."\n", + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'zh', + 'enumValueTitles' => ['', 'WEB', 'RPC', 'ROUTE', 'SQL'], + 'example' => '0', + 'enum' => ['0', '1', '2', '4', '3'], ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The HTTP status code returned.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'Success' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The code returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'Code' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Message' => [ - 'description' => 'The request is successfully processed.'."\n", - 'type' => 'string', - 'example' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Message' => ['title' => '', 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Code' => ['title' => '', 'description' => 'The response code returned.'."\n", 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => 'The number of configurations that are imported.'."\n", + 'title' => '', + 'description' => 'The details of the rule.'."\n", 'type' => 'object', 'properties' => [ - 'SuccCount' => [ - 'description' => 'The number of configurations that are skipped.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SkipCount' => [ - 'description' => 'The information about skipped configurations.'."\n", + 'Namespace' => ['title' => '', 'description' => 'The microservice namespace to which the application belongs.'."\n", 'type' => 'string', 'example' => 'default'], + 'Id' => ['title' => '', 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['title' => '', 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", 'type' => 'string', 'example' => '/a'], + 'StatIntervalMs' => ['title' => '', 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20000'], + 'Threshold' => ['title' => '', 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.8'], + 'Enable' => ['title' => '', 'description' => 'Indicates whether the rule is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Strategy' => [ + 'title' => '', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' Slow call ratio'."\n" + ."\n" + .' '."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' Abnormal proportion'."\n" + ."\n" + .' '."\n", 'type' => 'integer', 'format' => 'int32', - 'example' => '10', - ], - 'SkipData' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'DataId' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => 'The information about configurations that are failed to be imported.'."\n", - 'type' => 'string', - 'example' => 'public ', - ], - ], - ], - ], - 'FailData' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'DataId' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'string', - 'example' => 'test2.yaml', - ], - 'Group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Reason' => [ - 'type' => 'string', - ], - ], - ], + 'enumValueTitles' => ['', ''], + 'example' => '0', ], + 'RetryTimeoutMs' => ['title' => '', 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'AppId' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'RegionId' => ['title' => '', 'description' => 'The region in which the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], + 'MaxAllowedRtMs' => ['title' => '', 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'MinRequestAmount' => ['title' => '', 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'HalfOpenBaseAmountPerStep' => ['title' => '', 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'HalfOpenRecoveryStepNum' => ['title' => '', 'description' => 'The number of circuit breaking recovery steps.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + ], + ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Code\\": 1,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"SuccCount\\": 100,\\n \\"SkipCount\\": 10,\\n \\"SkipData\\": [\\n {\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"public \\"\\n }\\n ],\\n \\"FailData\\": [\\n {\\n \\"DataId\\": \\"test2.yaml\\",\\n \\"Group\\": \\"test\\",\\n \\"Reason\\": \\"导入配置格式错误\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ImportNacosConfig', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - ], - 'ListNamingTrack' => [ - 'summary' => 'Obtains the trajectory data of a Nacos registry.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], ], - 'tags' => [ - 'cluster', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"StatIntervalMs\\": 20000,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"Strategy\\": 0,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateCircuitBreakerRule', + 'summary' => 'Creates a circuit breaking rule.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCluster' => [ + 'summary' => 'Creates a registry and configuration center cluster, such as ZooKeeper or Nacos.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '137915', - 'abilityTreeNodes' => [ - 'FEATUREmseN8I3PF', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '17002', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'PubNetworkFlow', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '', 'description' => 'Valid when ConnectionType is set to `slb`. A value of 0 indicates that no Internet-facing SLB instance is created. A value of 1 or greater specifies the fixed bandwidth of the Internet-facing SLB instance, in Mbit/s.'."\n" + ."\n" + .'Valid values: 0 to 5000.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0'], ], [ - 'name' => 'InstanceId', + 'name' => 'PubSlbSpecification', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mse_prepaid_public_cn-tl32d*****', - ], + 'schema' => ['title' => '', 'description' => 'No longer used.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => ''], ], [ - 'name' => 'ServiceName', + 'name' => 'DiskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fpx-xms-baseinfo', - ], + 'schema' => ['title' => '', 'description' => 'No longer used.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => ''], ], [ - 'name' => 'Group', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'group', - ], + 'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-bp1t50e045b5g7i3p****', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'NetType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cd4d3703-e2a6-46b5-85c6-4447e4f****', - ], + 'schema' => ['description' => 'The network type. Valid values:'."\n" + .'- `privatenet`: virtual private cloud (VPC).'."\n" + .'- `pubnet`: Internet.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'privatenet', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vsw-bp17opt4v18sto39k****', 'title' => ''], + ], + [ + 'name' => 'InstanceCount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of instance nodes. Valid values: 1 to 9.'."\n" + .'[Professional Edition] '."\n" + ."\n" + .'- `NACOS_2_0_0`: Nacos 2.x.x.'."\n" + .'- `ZooKeeper_3_8_0`: ZooKeeper 3.8.x.'."\n" + .'[Developer Edition] '."\n" + ."\n" + .'- `NACOS_2_0_0`: Nacos 2.x.'."\n" + .'- `ZooKeeper_3_8_0`: ZooKeeper 3.8.x.'."\n" + .'[Serverless Edition]'."\n" + ."\n" + .'- `NACOS_2_0_0`: Nacos 2.x.'."\n" + .'- `ZooKeeper_3_8_0`: ZooKeeper 3.8.x.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3'], + ], + [ + 'name' => 'ClusterSpecification', + 'in' => 'query', + 'schema' => ['description' => 'The engine specifications. Valid values:', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MSE_SC_2_4_60_c', 'title' => ''], + ], + [ + 'name' => 'ClusterVersion', + 'in' => 'query', + 'schema' => ['description' => 'The cluster version. Valid values:', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NACOS_2_0_0', 'title' => ''], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => ['description' => 'The cluster type, such as ZooKeeper or Nacos-Ans.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Nacos-Ans', 'title' => ''], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The region where the cluster resides. Valid values include but are not limited to:'."\n" + .'- `ap-southeast-1`: Singapore'."\n" + .'- `cn-beijing`: Beijing'."\n" + .'- `cn-shanghai`: Shanghai'."\n" + .'- `cn-zhangjiakou`: Zhangjiakou'."\n" + .'- `cn-shenzhen`: Shenzhen.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PrivateSlbSpecification', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'No longer used.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => ''], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The network access type. Valid values: `slb` and `single_eni`. In some regions, the Developer Edition supports only the `single_eni` type.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'MseVersion', 'in' => 'query', 'schema' => [ - 'description' => 'The IP address of the client.'."\n", + 'title' => '', + 'description' => 'Required in most cases. Valid values:'."\n" + ."\n" + .'- `mse_pro`: Professional Edition.'."\n" + .'- `mse_dev`: Developer Edition.'."\n" + .'- `mse_serverless`: Serverless Edition.', + 'enumValueTitles' => ['mse_dev' => 'Developer Edition.', 'mse_serverless' => 'Serverless Edition.', 'mse_pro' => 'Professional Edition.'], 'type' => 'string', + 'example' => 'mse_pro', 'required' => false, - 'example' => '172.16.183.232', ], ], [ - 'name' => 'StartTs', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1660238450', - ], + 'schema' => ['title' => '', 'description' => 'The custom name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'tanshuyingtest001'], ], [ - 'name' => 'EndTs', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID. For more information about resource groups, see [View basic information of a resource group](~~457230~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzcqmoay3dlyq', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end timestamp. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1665299698', + 'title' => '', + 'description' => 'The list of tags to add. A maximum of 20 tags can be specified.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', + 'title' => '', + 'description' => 'The billing method. Valid values: PREPAY (subscription) and POSTPAY (pay-as-you-go).'."\n" + ."\n" + .'This parameter is ignored for the Serverless Edition.', + 'enumValueTitles' => ['PREPAY' => 'Subscription.', 'POSTPAY' => 'Pay-as-you-go.'], + 'type' => 'string', + 'required' => false, + 'example' => 'POSTPAY', ], ], [ - 'name' => 'PageNum', + 'name' => 'SecurityGroupType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'title' => '', + 'description' => 'Valid when ConnectionType is set to `single_eni`. Specifies the type of the security group to which the instance belongs.', + 'type' => 'string', + 'default' => 'enterprise', + 'enum' => ['enterprise', 'normal'], + 'required' => false, + 'example' => 'enterprise', ], ], [ - 'name' => 'Reverse', + 'name' => 'EipEnabled', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" - ."\n" - .'* `true`: sorts the query results in reverse chronological order.'."\n" - .'* `false`: sorts the query results in chronological order.'."\n", + 'title' => '', + 'description' => 'Valid when ConnectionType is set to `single_eni`. Specifies whether to enable public network access by using an elastic IP address (EIP).', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', + 'default' => 'false', 'required' => false, - 'example' => 'false', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Traces' => [ - 'description' => 'The data information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PushTime' => [ - 'description' => 'The push time.'."\n", - 'type' => 'string', - 'example' => '2022-12-16 11:48:07', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'mse-197*****-167083******-reg-center-0-0', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client.'."\n", - 'type' => 'string', - 'example' => '120.40.32.235', - ], - 'ServerName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'fpx-xms-baseinfo', - ], - 'Group' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'example' => 'prod', - ], - 'InstanceSize' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PushTimeAll' => [ - 'description' => 'The total push time.'."\n", - 'type' => 'string', - 'example' => '628ms', - ], - 'PushTimeNetwork' => [ - 'description' => 'The push time for the network.'."\n", - 'type' => 'string', - 'example' => '37ms', - ], - 'SlaTime' => [ - 'description' => 'The duration that is specified in the service-level agreement (SLA).'."\n", - 'type' => 'string', - 'example' => '628ms', - ], - ], - ], - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9916CBED-B2D5-5685-9129-4592FE1*****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dc63-465d-8ef5-20dc18af****', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '20574710974****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'- `true`: The request was successful.'."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 202 => [ - [ - 'errorCode' => 'TrackRegionNotSupport', - 'errorMessage' => '推送轨迹功能在当前Region暂未开放', - ], - ], 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"OrderId\\": \\"20574710974****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a registry and configuration center cluster', + 'description' => 'Before using this operation, make sure that you fully understand the billing methods and pricing of Microservices Engine (MSE).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"PushTime\\": \\"2022-12-16 11:48:07\\",\\n \\"NodeName\\": \\"mse-197*****-167083******-reg-center-0-0\\",\\n \\"ClientIp\\": \\"120.40.32.235\\",\\n \\"ServerName\\": \\"fpx-xms-baseinfo\\",\\n \\"Group\\": \\"prod\\",\\n \\"InstanceSize\\": \\"1\\",\\n \\"PushTimeAll\\": \\"628ms\\",\\n \\"PushTimeNetwork\\": \\"37ms\\",\\n \\"SlaTime\\": \\"628ms\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"9916CBED-B2D5-5685-9129-4592FE1*****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListNamingTrack', ], - 'CreateNacosService' => [ - 'summary' => 'Creates a Nacos service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateEngineNamespace' => [ + 'summary' => 'Creates a namespace in a Nacos instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '104937', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '17003', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], - ], - [ - 'name' => 'ServiceName', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'com.alibabacloud.hipstershop.cartserviceapi.service.CartService', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-98s****', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The display name of the namespace.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dev', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'production', - ], + 'schema' => ['description' => 'The description of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Development environment', 'title' => ''], ], [ - 'name' => 'ProtectThreshold', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The protection threshold.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-cn-st21ri2****', 'title' => ''], ], [ - 'name' => 'Ephemeral', + 'name' => 'ServiceCount', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the instance is marked as a temporary node. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The maximum number of services that can run in the namespace.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-3691a080', - ], + 'schema' => ['description' => 'The custom ID of the namespace. If you do not specify this parameter, the automatically generated Universally Unique Identifier (UUID) is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -7348,1824 +5045,1115 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'mse-892k****', 'title' => ''], 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'data', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* `0`: global configuration'."\n" + .'* `1`: default namespace'."\n" + .'* `2`: custom namespace'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NamespaceShowName' => ['description' => 'The display name of the namespace.'."\n", 'type' => 'string', 'example' => 'dev', 'title' => ''], + 'Quota' => ['description' => 'The quota of configurations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Namespace' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', 'title' => ''], + 'NamespaceDesc' => ['description' => 'The description of the namespace.'."\n", 'type' => 'string', 'example' => 'mytest', 'title' => ''], + 'ConfigCount' => ['description' => 'The number of configurations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ServiceCount' => ['description' => 'The number of active services.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"F6092602-C357-4750-89D9-E572FBEA****\\",\\n \\"ClusterId\\": \\"mse-892k****\\",\\n \\"Data\\": {\\n \\"Type\\": 1,\\n \\"NamespaceShowName\\": \\"dev\\",\\n \\"Quota\\": 1,\\n \\"Namespace\\": \\"f4fa5b81-2f26-4900-833a-7516b315ebb2\\",\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"ConfigCount\\": 1,\\n \\"ServiceCount\\": 3\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateEngineNamespace', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"data\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CreateNacosService', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'ListAnsServices' => [ - 'summary' => 'Queries Nacos services.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateFlowRule' => [ + 'summary' => 'Creates a throttling rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '17058', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'abilityTreeCode' => '163217', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'title' => '查询指定的服务名信息', - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - ], - [ - 'name' => 'GroupName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的分组', - 'description' => 'The name of the contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的 namespace', - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12233****', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a', 'title' => ''], ], [ - 'name' => 'ClusterName', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'title' => '查询服务下某个集群的实例列表是所需要的参数', - 'description' => '查询服务下某个集群的实例列表是所需要的参数', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The throttling threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'HasIpCount', + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to query the number of instances that are used for the service.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'false' => '', - 'true' => '', - ], - 'example' => 'true', + 'description' => 'Specifies whether to enable the rule.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'ClusterId', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'title' => '不推荐使用，请使用 InstanceId', - 'description' => 'The ID of the cluster.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-09k1q11****', - 'deprecated' => true, - ], + 'schema' => ['description' => 'The interface resource name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/b', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '集群实例Id', - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21v5****', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'ib09eblv6p@c3df23522******', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'ControlBehavior', 'in' => 'query', 'schema' => [ - 'title' => '查询第几页', - 'description' => 'The number of the page to return.'."\n", + 'description' => 'The throttling effect.', + 'enumValueTitles' => ['', 2 => ''], 'type' => 'integer', 'format' => 'int32', - 'required' => true, + 'required' => false, 'docRequired' => true, - 'example' => '1', + 'default' => '0', + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'MaxQueueingTimeMs', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示条数', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The timeout period. Unit: milliseconds. This parameter is required if the ControlBehavior parameter is set to 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The region in which the cluster resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RequestPars', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', + 'description' => 'The interface resource type.', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1', '2', '4', '3'], 'required' => false, - 'example' => '{}', + 'example' => '1', + 'title' => '', ], ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => ['description' => 'The source application of the request.', 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of instances returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Resource' => ['description' => 'The interface resource name.', 'type' => 'string', 'example' => 'app', 'title' => ''], + 'ControlBehavior' => [ + 'description' => 'The throttling effect.', + 'enumValueTitles' => ['', 2 => ''], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'MaxQueueingTimeMs' => ['description' => 'The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'Threshold' => ['description' => 'The throttling threshold.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''], + 'Enable' => [ + 'description' => 'Indicates whether the rule is enabled.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1po62@54e1f42f3******', 'title' => ''], + 'RegionId' => ['description' => 'The region of the gateway.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'LimitApp' => ['description' => 'The source application of the request.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'HealthyInstanceCount' => [ - 'description' => 'The total number of instances with healthy heartbeats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GroupName' => [ - 'description' => 'The name of the contact group.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'IpCount' => [ - 'description' => 'The total number of instances that are used for the current service.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'ClusterCount' => [ - 'description' => 'The total number of clusters.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Source' => [ - 'type' => 'string', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Success' => [ + 'description' => 'The result of the request.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'OperationNotSupport', - 'errorMessage' => 'The current cluster does not support this operation, %s.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 12,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"app\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 200,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@54e1f42f3******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"HealthyInstanceCount\\": 1,\\n \\"GroupName\\": \\"name\\",\\n \\"IpCount\\": 1,\\n \\"Name\\": \\"name\\",\\n \\"ClusterCount\\": 1,\\n \\"Source\\": \\"console\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n202\\n7\\n10\\n请求处理成功\\n52BA6DA6-A702-4362-A32F-DFF79655****\\n1\\n\\n name\\n 1\\n 1\\n 1\\n name\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListAnsServices', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'translator' => 'manual', ], - 'DeleteNacosService' => [ - 'summary' => 'Deletes a Nacos service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateGatewayCircuitBreakerRule' => [ + 'summary' => 'Creates a gateway circuit breaking rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '18547', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407', 'title' => ''], ], [ - 'name' => 'ServiceName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '645', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0****', - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'required' => true, 'example' => 'routeName', 'title' => ''], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => ['description' => 'The type of the threshold.'."\n" + ."\n" + .'0: slow call proportion'."\n" + ."\n" + .'1: failure proportion', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'TriggerRatio', + 'in' => 'query', + 'schema' => ['description' => 'The request percentage that triggers circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'StatDurationSec', + 'in' => 'query', + 'schema' => ['description' => 'The statistical duration for triggering circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '11', 'title' => ''], + ], + [ + 'name' => 'RecoveryTimeoutSec', + 'in' => 'query', + 'schema' => ['description' => 'The circuit breaking timeout period.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', 'title' => ''], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => ['description' => 'The minimum number of requests to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxAllowedMs', + 'in' => 'query', + 'schema' => ['description' => 'The threshold in slow call proportion mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: returns the specified content.'."\n" + ."\n" + .'1: redirects to the specified page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429', 'title' => ''], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP text to be returned.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => ['description' => 'The redirection URL.', 'type' => 'string', 'required' => false, 'example' => 'www.******.com', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disables the rule.'."\n" + ."\n" + .'1: enables the rule.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The string object.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'title' => '响应码', - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '删除服务的结果', - 'description' => 'The deletion result.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], + 'Data' => ['description' => 'The ID of the circuit breaking rule that you create.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": 28\\n}","type":"json"}]', + 'title' => 'CreateGatewayCircuitBreakerRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\n 请求成功\\n 200\\n true\\n ok\\n","errorExample":""}]', - 'title' => 'DeleteNacosService', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'UpdateNacosService' => [ - 'summary' => 'Updates the information about a Nacos service.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateGatewayFlowRule' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '105086', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ - 'name' => 'ServiceName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'com.dingtalk.doc.thumbnails.pdf.ThumbnailService', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'GroupName', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The ID of the route.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '52853'], ], [ - 'name' => 'NamespaceId', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', - ], + 'schema' => ['description' => 'The name of the routing rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'routeName'], ], [ - 'name' => 'ProtectThreshold', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => 'The protection threshold.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The overall queries per second (QPS) threshold.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ - 'name' => 'ClusterId', + 'name' => 'BehaviorType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: returns the specified content.'."\n" + ."\n" + .'1: redirects to the specified page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => 'The encoding format.'."\n" + ."\n" + .'0: normal text'."\n" + ."\n" + .'1: JSON'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP text to be returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'text'], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => ['description' => 'The address to be redirected to.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.******.com'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the throttling rule.'."\n" + ."\n" + .'0: disables the throttling rule.'."\n" + ."\n" + .'1: enables the throttling rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'string', - 'example' => '6', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****'], + 'Data' => ['description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '608'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72FC625E-9629-591B-9C01-3F0BFDAB****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', + 'title' => 'CreateGatewayFlowRule', + 'summary' => 'Creates a throttling rule for a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"6\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UpdateNacosService', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", ], - 'UpdateNacosCluster' => [ - 'summary' => 'Updates the information about a Nacos cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateGatewayIsolationRule' => [ + 'summary' => 'Creates a concurrency rule for a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '105189', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407', 'title' => ''], ], [ - 'name' => 'ServiceName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '服务名', - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'title' => '分组名', - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '52853', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], + 'schema' => ['description' => 'The name of the route.', 'type' => 'string', 'required' => true, 'example' => 'routeName', 'title' => ''], ], [ - 'name' => 'ClusterName', + 'name' => 'MaxConcurrency', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos集群名', - 'description' => 'The name of the Nacos cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DEFAULT', - ], + 'schema' => ['description' => 'The maximum number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], ], [ - 'name' => 'CheckPort', + 'name' => 'BehaviorType', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查端口', - 'description' => 'The port used for health checks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + 'schema' => ['description' => 'The type of a web fallback behavior.'."\n" + ."\n" + .'0: The specified content is returned.'."\n" + ."\n" + .'1: The specified page is displayed.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'UseInstancePortForCheck', + 'name' => 'BodyEncoding', 'in' => 'query', - 'schema' => [ - 'title' => '是否使用实例端口进行健康检查', - 'description' => 'Specifies whether to use the port of the instance for a health check.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'HealthChecker', + 'name' => 'ResponseStatusCode', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查类型', - 'description' => 'The type of the health check.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"type":"none"}', - ], + 'schema' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429', 'title' => ''], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP text to be returned.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => ['description' => 'The address to be redirected to.', 'type' => 'string', 'required' => false, 'example' => 'www.******.com', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disabled.'."\n" + ."\n" + .'1: enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want to display the results. Valid values: zh and en. zh is the default value, which indicates Chinese. en indicates English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'title' => '响应码', - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '修改结果', - 'description' => 'The result returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', 'title' => ''], + 'Data' => ['description' => 'The ID of the circuit breaking rule that you create.', 'type' => 'integer', 'format' => 'int64', 'example' => '608', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', + 'title' => 'CreateGatewayIsolationRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","type":"json"}]', - 'title' => 'UpdateNacosCluster', ], - 'ListAnsServiceClusters' => [ - 'summary' => 'Queries the clusters of a Nacos service.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateIsolationRule' => [ + 'summary' => 'Creates an isolation rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '17057', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '163570', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'PageNum', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'], ], [ - 'name' => 'PageSize', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'spring-cloud-a'], ], [ - 'name' => 'ClusterId', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the MSE cluster.'."\n" - ."\n" - .'> The MSE cluster is different from the cluster of the Nacos service.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'mse-09k1q110q01', - ], + 'schema' => ['description' => 'The concurrency threshold for the isolation rule.', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '3'], ], [ - 'name' => 'ServiceName', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'nacos.test.3', - ], + 'schema' => ['description' => 'Whether the rule is enabled.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], ], [ - 'name' => 'GroupName', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The name of the interface that the rule applies to. This must match the name displayed on the interface details page in the console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '/a'], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12233****', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], ], [ - 'name' => 'ClusterName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The alias of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-7413****', - ], + 'schema' => ['description' => 'The region of the cluster.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'LimitApp', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl32a6****', - ], + 'schema' => ['description' => 'The source application.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values: `zh` (default): Chinese, `en`: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'title' => '', + 'description' => 'The rule details.', 'type' => 'object', 'properties' => [ - 'ProtectThreshold' => [ - 'description' => 'The protection threshold.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'GroupName' => [ - 'description' => 'The service group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'Clusters' => [ - 'description' => 'The cluster information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'DefaultCheckPort' => [ - 'description' => 'The default port used for a health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'HealthCheckerType' => [ - 'description' => 'The type of the health check.'."\n", - 'type' => 'string', - 'example' => 'Heartbeat Reporting'."\n", - ], - 'UseIPPort4Check' => [ - 'description' => 'Indicates whether an end-to-end health check was initiated by the server. This parameter is valid only if the service is not a temporary service.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceName' => [ - 'description' => 'The full name of the service.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP@@nacos.test.3', - ], - 'Name' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DefaultPort' => [ - 'description' => 'The default port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Metadata' => [ - 'description' => 'The metadata of the cluster.'."\n", - 'type' => 'object', - 'example' => '111', - ], - ], - ], - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'nacos.test.3', - ], - 'SelectorType' => [ - 'description' => 'The election mode.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - 'Metadata' => [ - 'description' => 'The metadata of the service.'."\n", - 'type' => 'object', - 'example' => '111', - ], - 'Ephemeral' => [ - 'description' => 'Indicates whether the service is a temporary service. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Source' => [ - 'description' => 'The source type of the service. Valid values:'."\n" - ."\n" - .'* console: The service was registered in the console.'."\n" - .'* sdk: The service was registered by using the SDK.'."\n" - .'* governance: The service was registered on Microservices Governance.'."\n", - 'type' => 'string', - 'example' => 'console', - ], - 'AppDetail' => [ - 'description' => 'The information about the associated application for which Microservices Governance is enabled when the Source parameter is set to governance.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the application for which Microservices Governance is enabled.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@904cba2c0xxxxxx', - ], - 'AppName' => [ - 'description' => 'The name of the application for which Microservices Governance is enabled.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-b', - ], - 'Port' => [ - 'description' => 'The port number of the application for which Microservices Governance is enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6001', - ], - 'CheckType' => [ - 'description' => 'The type of the health check. Valid values:'."\n" - ."\n" - .'* connection: connection status check'."\n" - .'* tcp: TCP connection check'."\n" - .'* http: HTTP connection check'."\n", - 'type' => 'string', - 'example' => 'connection', - ], - 'CheckPath' => [ - 'description' => 'The path of the health check. This parameter is required only when the CheckType parameter is set to http.'."\n", - 'type' => 'string', - 'example' => '/health', - ], - 'CheckTimeout' => [ - 'description' => 'The timeout period of the health check response. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CheckInternal' => [ - 'description' => 'The health check interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HealthyCheckTimes' => [ - 'description' => 'The maximum number of health check retries when the instance state changes from unhealthy to healthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UnhealthyCheckTimes' => [ - 'description' => 'The maximum number of health check retries when the instance state changes from healthy to unhealthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], + 'Namespace' => ['description' => 'The microservice namespace of the application.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => 'The name of the interface to which the rule applies. This name must match the interface name displayed on the API Details page in the console.', 'type' => 'string', 'title' => '', 'example' => '/a'], + 'Threshold' => ['description' => 'The concurrency threshold for the isolation rule.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '3'], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'hpn9ac29kz@e31a4b871******'], + 'RegionId' => ['description' => 'The region where the cluster is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'LimitApp' => ['description' => 'The source application.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'example' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hpn9ac29kz@e31a4b871******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LimitApp\\": \\"\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateIsolationRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": {\\n \\"ProtectThreshold\\": 0,\\n \\"GroupName\\": \\"DEFAULT_GROUP\\",\\n \\"Clusters\\": [\\n {\\n \\"DefaultCheckPort\\": 80,\\n \\"HealthCheckerType\\": \\"connection：链接存活检查\\\\ntcp: TCP连接检查\\\\nhttp：HTTP连接检查\\",\\n \\"UseIPPort4Check\\": true,\\n \\"ServiceName\\": \\"DEFAULT_GROUP@@nacos.test.3\\",\\n \\"Name\\": \\"test\\",\\n \\"DefaultPort\\": 80,\\n \\"Metadata\\": 111\\n }\\n ],\\n \\"Name\\": \\"nacos.test.3\\",\\n \\"SelectorType\\": \\"none\\",\\n \\"Metadata\\": 111,\\n \\"Ephemeral\\": true,\\n \\"Source\\": \\"console\\",\\n \\"AppDetail\\": {\\n \\"AppId\\": \\"hkhon1po62@904cba2c0xxxxxx\\",\\n \\"AppName\\": \\"spring-cloud-b\\",\\n \\"Port\\": 6001,\\n \\"CheckType\\": \\"connection\\",\\n \\"CheckPath\\": \\"/health\\",\\n \\"CheckTimeout\\": 5,\\n \\"CheckInternal\\": 2,\\n \\"HealthyCheckTimes\\": 2,\\n \\"UnhealthyCheckTimes\\": 2\\n }\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\n52BA6DA6-A702-4362-A32F-DFF79655****\\n\\n DEFAULT_GROUP\\n none\\n 111\\n 0\\n DEFAULT\\n \\n true\\n 80\\n DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::\\n 111\\n 心跳上报\\n 80\\n test\\n \\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListAnsServiceClusters', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CreateNacosInstance' => [ - 'summary' => 'Creates a Nacos instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateMseServiceApplication' => [ + 'summary' => 'Creates an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '105182', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], - ], - [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'title' => '服务名', - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], - ], - [ - 'name' => 'GroupName', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '分组名', - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bsd-xxyp-open-goods-server', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides. Examples:'."\n" + ."\n" + .'* cn-hangzhou: China (Hangzhou)'."\n" + .'* cn-beijing: China (Beijing)'."\n" + .'* cn-shanghai: China (Shanghai)'."\n" + .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" + .'* cn-shenzhen: China (Shenzhen)'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''], ], [ - 'name' => 'ClusterName', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos集群名', - 'description' => 'The name of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['description' => 'The service source.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'edasmsc', 'default' => 'edasmsc', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例ip', - 'description' => 'The IP address of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1.2.xx.xx', - ], + 'schema' => ['description' => 'The programming language of the application.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'JAVA', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'ExtraInfo', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例端口', - 'description' => 'The port number of the Nacos instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '65535', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '12281', - ], + 'schema' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Ephemeral', + 'name' => 'SentinelEnable', 'in' => 'query', - 'schema' => [ - 'title' => '临时节点标志', - 'description' => 'Specifies whether to mark the instance as a temporary node.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to enable the Sentinel-compatible mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], ], [ - 'name' => 'Weight', + 'name' => 'SwitchEnable', 'in' => 'query', - 'schema' => [ - 'title' => '权重', - 'description' => 'The weight. Valid values: 0 to 10000. The value must be an integer. A larger value indicates a higher frequency at which the instance is accessed.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to enable switching.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], ], [ - 'name' => 'Enabled', + 'name' => 'MseVersion', 'in' => 'query', - 'schema' => [ - 'title' => '服务禁用标志', - 'description' => 'Specifies whether to enable the service for the instance.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'Metadata', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点元数据', - 'description' => 'The node metadata of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"grayversion\\":\\"1.0\\",\\"preserved.register.source\\":\\"SPRING_CLOUD\\",\\"management.context-path\\":\\"\\"}', - ], + 'schema' => ['description' => 'The edition of the MSE instance that you want to purchase.'."\n" + ."\n" + .'* mse_pro: Professional Edition.'."\n" + .'* mse_dev: Developer Edition.', 'type' => 'string', 'required' => false, 'example' => 'mse_pro', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'title' => '响应码', - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '904F6C04-1284-****-8ED2-FFC57E507A72', 'title' => ''], 'Data' => [ - 'title' => '修改结果', - 'description' => 'The result returned.'."\n", - 'type' => 'string', - 'example' => 'ok', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status. Valid values: 1: available; 2: deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ExtraInfo' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'UpdateTime' => ['description' => 'The last modification time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663', 'title' => ''], + 'LicenseKey' => ['description' => 'The license key in use.'."\n", 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'Source' => ['description' => 'The source type.'."\n", 'type' => 'string', 'example' => 'edasmsc', 'title' => ''], + 'Language' => ['description' => 'The programming language of the application.'."\n", 'type' => 'string', 'example' => 'JAVA', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Version' => ['description' => 'The version information.'."\n", 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","type":"json"}]', - 'title' => 'CreateNacosInstance', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - ], - 'DeleteNacosInstance' => [ - 'summary' => 'Deletes a persistent application instance from a Microservices Engine (MSE) Nacos instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => [ + 'substitutions' => ['mse::2019-05-31::CreateApplication'], + 'returnType' => 'synchronous', ], - 'tags' => [ - 'cluster', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"904F6C04-1284-****-8ED2-FFC57E507A72\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"UpdateTime\\": 1632979237663,\\n \\"LicenseKey\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"CreateTime\\": 1631001140913,\\n \\"AppId\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'CreateMseServiceApplication', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateMseServiceApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNacosConfig' => [ + 'summary' => 'Creates a Nacos configuration.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '121118', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17005', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-st21v5****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-tl32****', 'title' => ''], ], [ - 'name' => 'ServiceName', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hello_service', - ], + 'schema' => ['description' => 'The ID of the data.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'common.yaml', 'title' => ''], ], [ - 'name' => 'NamespaceId', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', - ], + 'schema' => ['description' => 'The ID of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alime-bridge-aliyun', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'saledatacenter-task', 'title' => ''], ], [ - 'name' => 'ClusterName', + 'name' => 'Tags', 'in' => 'query', - 'schema' => [ - 'description' => 'The alias of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - 'default' => 'DEFAULT', - ], + 'schema' => ['description' => 'The tags of the configuration.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Basic configuration', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10.237.1.32', - ], + 'schema' => ['description' => 'The description of the configuration.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Base module configuration', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The port of the Nacos instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8080', - ], + 'schema' => ['description' => 'The format of the configuration. Supported formats include TEXT, JSON, and XML.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'text', 'title' => ''], ], [ - 'name' => 'Ephemeral', + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The content of the configuration.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'text', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the node is an ephemeral node. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '547fd2a0-d0d6-****-80db2a1afb82', 'title' => ''], + ], + [ + 'name' => 'BetaIps', + 'in' => 'query', + 'schema' => ['description' => 'The list of IP addresses where the beta release of the configuration is performed.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.117.XX.XX,100.117.XX.XX', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. The value 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'HttpCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '673DBD43-569E-510F-B3DE-20BB8DFEB20A', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The code returned.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": \\"OK\\"\\n}","type":"json"}]', - 'title' => 'DeleteNacosInstance', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - ], - 'UpdateNacosInstance' => [ - 'summary' => 'Updates the information about application instances that are registered with a Nacos instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'cluster', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"673DBD43-569E-510F-B3DE-20BB8DFEB20A\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateNacosConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNacosInstance' => [ + 'summary' => 'Creates a Nacos instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -9174,385 +6162,305 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '18554', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '105182', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], ], [ 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '服务名', - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], + 'schema' => ['title' => '', 'description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '分组名', - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['title' => '', 'description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], ], [ 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****'], ], [ 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos集群名', - 'description' => 'The name of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Nacos instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], ], [ 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例ip', - 'description' => 'The IP address of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1.2.X.X', - ], + 'schema' => ['title' => '', 'description' => 'The IP address of the Nacos instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '1.2.xx.xx'], ], [ 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例端口', - 'description' => 'The port number of the Nacos instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12281', - ], + 'schema' => ['title' => '', 'description' => 'The port number of the Nacos instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12281'], ], [ 'name' => 'Ephemeral', 'in' => 'query', - 'schema' => [ - 'title' => '临时节点标志', - 'description' => 'Specifies whether the node is a non-persistent node. Valid values:'."\n" - ."\n" - .'* `true`: yes.'."\n" - .'* `false`: no.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to mark the instance as a temporary node.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false'], ], [ 'name' => 'Weight', 'in' => 'query', - 'schema' => [ - 'title' => '权重', - 'description' => 'The weight. Valid values: 0 to 10000. The value must be an integer. A larger value indicates a higher frequency at which the instance is accessed.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The weight. Valid values: 0 to 10000. The value must be an integer. A larger value indicates a higher frequency at which the instance is accessed.'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'title' => '服务禁用标志', - 'description' => 'Specifies whether to disable this service. Valid values:'."\n" - ."\n" - .'* `true`: yes.'."\n" - .'* `false`: no.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the service for the instance.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'Metadata', 'in' => 'formData', - 'schema' => [ - 'title' => '节点元数据', - 'description' => 'The metadata of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[int]', - ], + 'schema' => ['title' => '', 'description' => 'The node metadata of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"grayversion\\":\\"1.0\\",\\"preserved.register.source\\":\\"SPRING_CLOUD\\",\\"management.context-path\\":\\"\\"}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The string object.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'title' => '响应码', - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '修改结果', - 'description' => 'The result of the modification.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '', 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '', 'description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '', 'description' => 'The result returned.'."\n", 'type' => 'string', 'example' => 'ok'], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\n 请求成功\\n 200\\n true\\n ok\\n","errorExample":""}]', - 'title' => 'UpdateNacosInstance', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'CreateNacosInstance', 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - ], - 'ListAnsInstances' => [ - 'summary' => 'Queries application instances that are registered with a Microservices Engine (MSE) Nacos instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNacosService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '17056', - 'abilityTreeNodes' => [ - 'FEATUREmseAPH368', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '104937', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'PageNum', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'com.alibabacloud.hipstershop.cartserviceapi.service.CartService'], ], [ - 'name' => 'PageSize', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'ClusterId', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Nacos instance.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - 'deprecated' => true, - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'production'], ], [ - 'name' => 'ServiceName', + 'name' => 'ProtectThreshold', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'name', - ], + 'schema' => ['description' => 'The protection threshold.'."\n", 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'GroupName', + 'name' => 'Ephemeral', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Specifies whether the instance is marked as a temporary node. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'NamespaceId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12233****', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-3691a080'], ], [ - 'name' => 'ClusterName', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The alias of the Nacos instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-7413****', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'example' => 'data'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'InstanceId', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"data\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'CreateNacosService', + 'summary' => 'Creates a Nacos service.', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateNamespace' => [ + 'summary' => 'Creates a namespace for Microservices Governance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '187065', + 'abilityTreeNodes' => ['FEATUREmseSXV85E'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace that you want to create for Microservices Governance.', 'type' => 'string', 'example' => 'myNamespace', 'maxLength' => 64, 'title' => '', 'required' => false], + ], + [ + 'name' => 'Describe', 'in' => 'query', + 'schema' => ['description' => 'The description of the namespace that you want to create for Microservices Governance.', 'type' => 'string', 'required' => false, 'example' => 'Test namespace 1.', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the resource. You cannot specify an empty string as a tag key. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'namespaceTagKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'namespaceTagValue', 'title' => ''], + ], + 'description' => 'The list of tags to be added. The list can contain up to 20 items.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'minItems' => 0, + 'description' => 'The tag.', 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl327w****', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -9560,2530 +6468,1323 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'title' => '', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => 'The request ID', 'type' => 'string', 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DefaultKey' => [ - 'description' => 'The default key.'."\n", - 'type' => 'string', - 'example' => '30.5.XX.XX:unknown', - ], - 'Ephemeral' => [ - 'description' => 'Indicates whether the information about the ephemeral node is obtained. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Marked' => [ - 'description' => 'Indicates whether the instance was marked. Valid values:'."\n" - ."\n" - .'* `true`: The instance marking was successful.'."\n" - .'* `false`: The instance marking failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Ip' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '30.5.XX.XX', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => '30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService', - ], - 'Port' => [ - 'description' => 'The port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'LastBeat' => [ - 'description' => 'The last heartbeat time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20201010', - ], - 'OkCount' => [ - 'description' => 'The number of counted successes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Weight' => [ - 'description' => 'The weight.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'InstanceHeartBeatInterval' => [ - 'description' => 'The heartbeat interval of the instance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5000', - ], - 'IpDeleteTimeout' => [ - 'description' => 'The timeout period for removing an IP address.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - ], - 'App' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'app', - ], - 'FailCount' => [ - 'description' => 'The number of counted failures.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Healthy' => [ - 'description' => 'The health status of the instance. Valid values:'."\n" - ."\n" - .'* `true`: The instance is healthy.'."\n" - .'* `false`: The instance is unhealthy.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Enabled' => [ - 'description' => 'The effective status of the instance. Valid values:'."\n" - ."\n" - .'* `true`: The instance takes effect.'."\n" - .'* `false`: The instance does not take effect.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DatumKey' => [ - 'description' => 'The reference key.'."\n", - 'type' => 'string', - 'example' => '30.5.XX.XX:unknown:DEFAULT', - ], - 'ClusterName' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'InstanceHeartBeatTimeOut' => [ - 'description' => 'The timeout period of the instance heartbeat.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15000', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::', - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'object', - 'example' => '[int]', - ], - ], + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region to which the namespace belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'myNamespace', 'title' => ''], ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"D1F1A6F3-7E03-5EAD-B3F1-123456789ABC\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateNamespace', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"DefaultKey\\": \\"30.5.XX.XX:unknown\\",\\n \\"Ephemeral\\": true,\\n \\"Marked\\": true,\\n \\"Ip\\": \\"30.5.XX.XX\\",\\n \\"InstanceId\\": \\"30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService\\",\\n \\"Port\\": 8080,\\n \\"LastBeat\\": 20201010,\\n \\"OkCount\\": 0,\\n \\"Weight\\": 1,\\n \\"InstanceHeartBeatInterval\\": 5000,\\n \\"IpDeleteTimeout\\": 30000,\\n \\"App\\": \\"app\\",\\n \\"FailCount\\": 0,\\n \\"Healthy\\": true,\\n \\"Enabled\\": true,\\n \\"DatumKey\\": \\"30.5.XX.XX:unknown:DEFAULT\\",\\n \\"ClusterName\\": \\"DEFAULT\\",\\n \\"InstanceHeartBeatTimeOut\\": 15000,\\n \\"ServiceName\\": \\"DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::\\",\\n \\"Metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n202\\n7\\n10\\n请求处理成功\\n52BA6DA6-A702-4362-A32F-DFF79655****\\n1\\n\\n app\\n 30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService\\n 30.5.XX.XX\\n 8080\\n [int]\\n true\\n 1\\n 30.5.XX.XX:unknown:DEFAULT\\n 0\\n DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::\\n 0\\n DEFAULT\\n 20201010\\n 30.5.XX.XX:unknown\\n 15000\\n true\\n 30000\\n true\\n true\\n 5000\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListAnsInstances', - 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetServiceListeners' => [ - 'summary' => 'Queries the list of listeners for the destination service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateOrUpdateSwimmingLane' => [ + 'summary' => 'Creates or updates an end-to-end canary release swimming lane.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '137871', - 'abilityTreeNodes' => [ - 'FEATUREmseXDLQRG', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '116127', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], ], 'parameters' => [ [ - 'name' => 'ServiceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定的服务名信息', - 'description' => 'The name of the service whose listeners you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zeekr-orderboss', - ], + 'schema' => ['title' => 'region', 'description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'GroupName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的分组', - 'description' => 'The group to which the service belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WEB_GROUP', - ], + 'schema' => ['description' => 'The name of the MSE namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'NamespaceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的 namespace', - 'description' => 'The namespace to which the service belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', - ], + 'schema' => ['description' => 'The primary key ID. Set the value to -1 to create a swimming lane. Set the value to a number greater than 0 to modify a specific swimming lane.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => '', 'required' => false], ], [ - 'name' => 'ClusterName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '查询服务下某个集群的实例列表是所需要的参数', - 'description' => 'The name of the cluster to which the service belongs.'."\n" - ."\n" - .'> The cluster is a concept for Nacos services and is not equivalent to a Microservices Engine (MSE) instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['description' => 'The name of the swimming lane.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'gray'], ], [ - 'name' => 'HasIpCount', + 'name' => 'Tag', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'none', - ], + 'schema' => ['description' => 'The tag.', 'type' => 'string', 'example' => 'gray', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'ClusterId', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'title' => '当前查询服务的集群标识', - 'description' => 'The ID of the MSE instance to which the service belongs.'."\n" - ."\n" - .'> You must specify InstanceId or ClusterId.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'Specifies whether to enable the swimming lane.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'InstanceId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '当前查询服务的集群标识', - 'description' => 'The ID of the instance to which the service belongs.'."\n" - ."\n" - .'> You must specify InstanceId or ClusterId.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl32odtt20j', - ], + 'schema' => ['description' => 'The ID of the swimming lane group.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '115'], ], [ - 'name' => 'PageNum', + 'name' => 'EnableRules', 'in' => 'query', - 'schema' => [ - 'title' => '查询第几页', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to configure a routing rule for the swimming lane. You do not need to configure a routing rule for an Ingress.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'PageSize', + 'name' => 'PathIndependentPercentageEnable', 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. This parameter is a configuration item for Java gateways and is used for path-based routing by percentage.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'EntryRules', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'title' => '每页展示条数', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => 'SwimmingLane', + 'description' => 'The collection of swimming lane rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'title' => '', + 'description' => 'The list of paths.', + 'type' => 'array', + 'items' => ['description' => 'The path.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], + 'required' => false, + 'maxItems' => 50, + 'example' => '', + ], + 'Condition' => [ + 'description' => 'Specifies how to combine the RestItems to form the final condition.', + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + 'default' => 'AND', + 'enum' => ['AND', 'OR'], + 'title' => '', + ], + 'RestItems' => [ + 'title' => '', + 'description' => 'The list of matching rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The RESTful matching information.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The matching type.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'header'], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'x-mse-tag'], + 'Operator' => ['description' => 'The operator.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rawvalue'], + 'NameList' => [ + 'title' => '', + 'description' => 'The list of matching rules.', + 'type' => 'array', + 'items' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + 'Datum' => ['description' => 'The value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'x'], + 'Cond' => ['description' => 'The matching operator.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '=='."\n"], + 'Divisor' => ['description' => 'The divisor.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'Remainder' => ['description' => 'The remainder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'Rate' => ['description' => 'The percentage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'gray'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + 'Priority' => ['description' => 'The priority.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'title' => '', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'description' => 'The swimming lane rule.', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '10', + 'maxItems' => 10, + 'example' => '', ], ], [ - 'name' => 'RegionId', + 'name' => 'EntryRule', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'json string', 'description' => 'A JSON string.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '[{"Priority":1,"Paths":[],"Condition":"AND","RestItems":[{"Type":"param","Name":"name","Value":"xiaoming","Cond":"==","Operator":"rawvalue"}]}]'], ], [ - 'name' => 'RequestPars', + 'name' => 'GatewaySwimmingLaneRouteJson', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The gateway routing information. This parameter is used when you use a cloud-native gateway as the ingress.', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-84efde2ee1464260bdb17a5b****', 'title' => '', 'required' => false], + 'RouteIdList' => [ + 'title' => '', + 'description' => 'The list of route IDs.', + 'type' => 'array', + 'items' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false, 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'CanaryModel' => ['description' => 'The end-to-end canary release mode:'."\n" + ."\n" + .'- 0: Route by request content.'."\n" + ."\n" + .'- 1: Route by percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], + 'Conditions' => [ + 'title' => '', + 'description' => 'The list of matching conditions.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The condition item.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'name', 'title' => '', 'required' => false], + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'xiaoming', 'title' => '', 'required' => false], + 'Type' => ['description' => 'The parameter type:'."\n" + ."\n" + .'- header: Header'."\n" + ."\n" + .'- param: Parameter', 'type' => 'string', 'example' => 'header', 'title' => '', 'required' => false], + 'Cond' => ['description' => 'If you use an earlier version of end-to-end canary release (swimversion is 0, which uses tag-based routing and canary routing), the following values are supported:'."\n" + ."\n" + .'- PRE: prefix match'."\n" + ."\n" + .'- REGULAR: regular expression match'."\n" + ."\n" + .'- EQUAL: exact match'."\n" + ."\n" + .'If you use a later version of end-to-end canary release (swimversion is 1 or 2, which uses single-service routing), the following values are supported:'."\n" + ."\n" + .'- PRE: prefix match'."\n" + ."\n" + .'- regexp: regular expression match'."\n" + ."\n" + .'- \\=='."\n" + ."\n" + .'- !='."\n" + ."\n" + .'- list: in'."\n" + ."\n" + .'- %: percentage'."\n" + ."\n" + .'The later version of end-to-end canary release provides the same features as the earlier version but delivers higher performance and allows for easier configurations. Migrate to the later version.', 'type' => 'string', 'example' => 'PRE', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Percentage' => ['description' => 'The traffic percentage. This parameter is used for routing by percentage. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => '', 'required' => false], + 'RouteIndependentPercentageEnable' => ['description' => 'This parameter is deprecated. This parameter is used to specify percentage-based settings for routing when you use an MSE cloud-native gateway as the ingress.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + 'RouteIndependentPercentageList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteId' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], + 'Percentage' => ['description' => 'The traffic percentage. This parameter is used for routing by percentage. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + ], + 'description' => 'The list of routes and percentages.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'This parameter is deprecated. The list of routes for which canary release by percentage is independently configured.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Condition' => ['description' => 'AND: All canary release conditions must be met.'."\n" + .'OR: Any of the canary release conditions can be met.', 'type' => 'string', 'required' => false, 'example' => 'AND', 'title' => ''], + ], 'required' => false, - 'example' => '{}', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values: zh (default): Chinese, en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RegCenterOperatorResult', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The code is used for synchronization with the Success parameter.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Addr' => [ - 'title' => '地址', - 'description' => 'The IP address of the listener.'."\n", - 'type' => 'string', - 'example' => '119.23.84.102', - ], - 'Agent' => [ - 'title' => '客户端版本', - 'description' => 'The listener client version.'."\n", - 'type' => 'string', - 'example' => 'Nacos-Java-Client:v2.1.1', - ], - 'App' => [ - 'title' => '应用', - 'description' => 'The application name of the listener.'."\n", - 'type' => 'string', - 'example' => 'app', - ], - 'IP' => [ - 'title' => 'ip地址', - 'description' => 'The IP address of the monitored service.'."\n", - 'type' => 'string', - 'example' => '172.16.1.5', - ], - 'Port' => [ - 'title' => '端口号', - 'description' => 'The port number of the monitored service.'."\n", - 'type' => 'string', - 'example' => '8080', - ], - 'NamespaceId' => [ - 'title' => '命名空间id', - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => '0ba53825-b183-414f-a6a0-288e4f1c467e', - ], - 'ServiceName' => [ - 'title' => '服务名称', - 'description' => 'The name of the monitored service.'."\n", - 'type' => 'string', - 'example' => 'zeekr-orderboss', - ], - 'Cluster' => [ - 'title' => '集群名称', - 'description' => 'The name of the cluster to which the monitored service belongs.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', + 'description' => 'The data overview.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the swimming lane.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'id' => ['description' => 'The ID of the swimming lane.', 'type' => 'integer', 'format' => 'int64', 'example' => '94765', 'title' => ''], + 'tag' => ['description' => 'The tag that corresponds to the swimming lane.', 'type' => 'string', 'example' => 'release', 'title' => ''], + 'status' => ['description' => 'The status of the swimming lane.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'enable' => ['description' => 'Indicates whether the swimming lane is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'regionId' => ['description' => 'The region where the application resides.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'groupId' => ['description' => 'The ID of the swimming lane group.', 'type' => 'integer', 'format' => 'int64', 'example' => '72586', 'title' => ''], + 'entryRule' => ['description' => 'The rule for the ingress application.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'entryRules' => [ + 'description' => 'The rule name.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the rule for the ingress application.', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => 'The list of paths.', + 'type' => 'array', + 'items' => ['description' => 'The path.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'path' => ['description' => 'The path of the code group.', 'type' => 'string', 'title' => '', 'example' => '/adump/wxb/prod'], + 'condition' => ['description' => 'The condition.', 'type' => 'string', 'example' => 'AND', 'title' => ''], + 'restItems' => [ + 'description' => 'The list of RESTful matching rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The RESTful matching rule.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The matching type.', 'type' => 'string', 'title' => '', 'example' => 'cookie'], + 'name' => ['description' => 'The name.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'operator' => ['description' => 'The operator.', 'type' => 'string', 'title' => '', 'example' => 'rawvalue'], + 'nameList' => [ + 'title' => '', + 'description' => 'The list of names.', + 'type' => 'array', + 'items' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'maxItems' => 10, + 'example' => '', + ], + 'datum' => ['description' => 'The value.', 'type' => 'string', 'title' => '', 'example' => 'x'], + 'cond' => ['description' => 'The matching operator.', 'type' => 'string', 'title' => '', 'example' => '=='], + 'divisor' => ['description' => 'The divisor.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'remainder' => ['description' => 'The remainder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'rate' => ['description' => 'The percentage', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'value' => ['description' => 'Value', 'type' => 'string', 'title' => '', 'example' => '9'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'enableRules' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'gmtCreate' => ['description' => 'The time when the swimming lane was created.', 'type' => 'string', 'example' => '1545726028000', 'title' => ''], + 'gmtModified' => ['description' => 'The time when the swimming lane was updated.', 'type' => 'string', 'example' => '1565701886000', 'title' => ''], + 'gatewaySwimmingLaneRouteJson' => ['description' => 'The routing rule of the MSE gateway.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'pathIndependentPercentageEnable' => ['description' => 'This parameter is deprecated. This parameter is used when a Java gateway is the ingress. It specifies whether to enable canary release by path percentage.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - ], - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'title' => '查询到的实例总数', - 'description' => 'The number of listeners that are queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', + 'example' => '{}', + 'title' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Succ\\",\\n \\"Data\\": {\\n \\"name\\": \\"test\\",\\n \\"id\\": 94765,\\n \\"tag\\": \\"release\\",\\n \\"status\\": 0,\\n \\"enable\\": true,\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"groupId\\": 72586,\\n \\"entryRule\\": \\"{}\\",\\n \\"entryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/adump/wxb/prod\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"test\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"9\\"\\n }\\n ]\\n }\\n ],\\n \\"enableRules\\": true,\\n \\"gmtCreate\\": \\"1545726028000\\",\\n \\"gmtModified\\": \\"1565701886000\\",\\n \\"gatewaySwimmingLaneRouteJson\\": \\"{}\\",\\n \\"pathIndependentPercentageEnable\\": false\\n }\\n}","type":"json"}]', + 'title' => 'CreateOrUpdateSwimmingLane', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateOrUpdateSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Addr\\": \\"119.23.84.102\\",\\n \\"Agent\\": \\"Nacos-Java-Client:v2.1.1\\",\\n \\"App\\": \\"app\\",\\n \\"IP\\": \\"172.16.1.5\\",\\n \\"Port\\": \\"8080\\",\\n \\"NamespaceId\\": \\"0ba53825-b183-414f-a6a0-288e4f1c467e\\",\\n \\"ServiceName\\": \\"zeekr-orderboss\\",\\n \\"Cluster\\": \\"DEFAULT\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\"\\n}","type":"json"}]', - 'title' => 'GetServiceListeners', ], - 'ListEurekaServices' => [ - 'summary' => 'Queries Eureka services.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateOrUpdateSwimmingLaneGroup' => [ + 'summary' => 'Creates or updates a lane group for an end-to-end canary release.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17068', - 'abilityTreeNodes' => [ - 'FEATUREmseKQ13CA', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '116107', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => 'region', 'description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], [ - 'name' => 'PageNum', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the MSE namespace.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default', 'maxLength' => 64, 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the lane group. If you set this parameter to -1, a lane group is created. If you set this parameter to a value greater than 0, the specified lane group is modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The name of the lane group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'group1'], ], [ - 'name' => 'RegionId', + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the lane group is enabled. A value of 0 indicates that the lane group is disabled. A value of 1 indicates that the lane group is enabled.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'EntryApp', + 'in' => 'query', + 'schema' => ['description' => 'The entry application. The value is in the Source:ID format. Examples:'."\n" + ."\n" + .'- mse:${MSE application ID}'."\n" + ."\n" + .'- mse-gw:${MSE cloud-native gateway ID}'."\n" + ."\n" + .'- apig:${cloud-native API Gateway ID}', 'type' => 'string', 'example' => 'mse-gw:gw-2b1407e050f1446xxxcd2a65fd9xxxx', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of applications. Separate multiple application IDs with commas (,).', 'type' => 'string', 'example' => 'xxxxn1po62@492b8f98d4bxxxx,xxxxn1po62@2d8f5d1b7f2xxxx', 'title' => '', 'required' => false], + ], + [ + 'name' => 'MessageQueueGrayEnable', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable canary release for messages.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'default' => 'false', + 'title' => '', 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'example' => 'true', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'MessageQueueFilterSide', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", + 'description' => 'The side for message filtering in a canary release.', 'type' => 'string', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => ['Server', 'Client'], + 'title' => '', 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstancesId' => [ - 'description' => 'The details of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'CONTACTINFO', - ], - 'UpStatus' => [ - 'description' => 'The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.'."\n", - 'type' => 'string', - 'example' => '1/1', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"InstancesId\\": [\\n \\"mse-cn-st21ri2****\\"\\n ],\\n \\"Name\\": \\"CONTACTINFO\\",\\n \\"UpStatus\\": \\"1/1\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n202\\n7\\n10\\n请求处理成功\\n316F5F64-F73D-42DC-8632-01E308B6****\\n1\\n\\n 1/1\\n CONTACTINFO\\n mse-cn-st21ri2****\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListEurekaServices', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListEurekaInstances' => [ - 'summary' => 'Queries Eureka instances.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17067', - 'abilityTreeNodes' => [ - 'FEATUREmseKQ13CA', - ], - ], - 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'DbGrayEnable', 'in' => 'query', 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', + 'description' => 'This parameter is deprecated. Specifies whether to enable canary release for databases.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'title' => '', 'required' => false, - 'example' => '{}', + 'example' => 'true', ], ], [ - 'name' => 'PageNum', + 'name' => 'RecordCanaryDetail', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to record the details of canary release requests.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'PageSize', + 'name' => 'Paths', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated. The path.', 'type' => 'string', 'required' => false, 'example' => 'a', 'title' => ''], + 'description' => 'This parameter is deprecated. This parameter is used when a Java gateway is the entry application.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ClusterId', + 'name' => 'RouteIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], + 'description' => 'The list of route IDs. If a cloud-native gateway is used as the entry application, you must call this operation to pass the list of route IDs for the cloud-native gateway before you create a lane for the lane group.', + 'title' => '', 'required' => false, - 'example' => 'mse-09k1q11****', + 'example' => '', ], ], [ - 'name' => 'ServiceName', + 'name' => 'CanaryModel', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'name', - ], + 'schema' => ['description' => 'The canary release mode.'."\n" + ."\n" + .'- 0: Content-based routing'."\n" + ."\n" + .'- 1: Proportional routing', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SwimVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the end-to-end canary release. Valid values: 0 and 2. A value of 0 is not recommended because you must specify a route. A value of 2 is recommended because you do not need to specify a route.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: \\`true\\` and \\`false\\`.'."\n" + ."\n" + .'true: The request was successful.'."\n" + .'false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.'."\n", - 'type' => 'string', - 'example' => '1/1', - ], - 'LastDirtyTimestamp' => [ - 'description' => 'The time when the instance was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20201009115543', - ], - 'IpAddr' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '30.5.XX.XX', - ], - 'HomePageUrl' => [ - 'description' => 'The URL of the homepage.'."\n", - 'type' => 'string', - 'example' => 'http://30.5.XX.XX:8091/', - ], - 'HostName' => [ - 'description' => 'The hostname.'."\n", - 'type' => 'string', - 'example' => '30.5.XX.XX', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'L-PC1A6A28-****.hz.ali.com:contactinfo:8091', - ], - 'Port' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8091', - ], - 'SecurePort' => [ - 'description' => 'The security port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - 'App' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'CONTACTINFO', - ], - 'DurationInSecs' => [ - 'description' => 'The timeout period of the instance.\\'."\n" - .'After the specified timeout period expires, the service is unavailable by default and is deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'LastUpdatedTimestamp' => [ - 'description' => 'The time when the instance heartbeat was last checked.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20201010071203', - ], - 'RenewalIntervalInSecs' => [ - 'description' => 'The maximum interval between two heartbeat checks after a heartbeat check times out.\\'."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'VipAddress' => [ - 'description' => 'The virtual IP address (VIP).'."\n", - 'type' => 'string', - 'example' => 'contactinfo', - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'object', - 'example' => '[string]', - ], - ], + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'example-app', 'title' => ''], + 'DbGrayEnable' => ['description' => 'Indicates whether canary release is enabled for databases.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to which the application belongs.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'MessageQueueFilterSide' => ['description' => 'The side for message filtering in a canary release.', 'type' => 'string', 'example' => 'Client', 'title' => ''], + 'AppIds' => ['description' => 'A list of application IDs, separated by commas (,).', 'type' => 'string', 'example' => 'abcd1@abcde123,abcd1@abcde124', 'title' => ''], + 'Namespace' => ['description' => 'The name of the MSE namespace.', 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'RecordCanaryDetail' => ['description' => 'Indicates whether the details of canary release requests are recorded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Id' => ['description' => 'The ID of the lane group.', 'type' => 'integer', 'format' => 'int64', 'default' => '123', 'title' => '', 'example' => '2047'], + 'EntryApp' => ['description' => 'The entry application.', 'type' => 'string', 'example' => 'mse:abcd1@a2345', 'title' => ''], + 'Region' => ['description' => 'The region where the application resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'MessageQueueGrayEnable' => ['description' => 'Indicates whether canary release is enabled for messages.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'paths' => ['description' => 'This parameter is deprecated. If a Java gateway is the entry application, this parameter specifies a list of paths.', 'type' => 'string', 'example' => '["/a"]', 'title' => ''], + 'Paths' => ['description' => 'This parameter is deprecated. If a Java gateway is the entry application, this parameter specifies a list of paths.', 'type' => 'string', 'example' => '["/a"]', 'title' => ''], + 'canaryModel' => ['description' => 'The canary release mode.'."\n" + ."\n" + .'- 0: Content-based routing'."\n" + ."\n" + .'- 1: Proportional routing', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CanaryModel' => ['description' => 'The canary release mode.'."\n" + ."\n" + .'- 0: Content-based routing'."\n" + ."\n" + .'- 1: Proportional routing', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'example' => '{}', + 'title' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"Succ\\",\\n \\"Data\\": {\\n \\"Name\\": \\"example-app\\",\\n \\"DbGrayEnable\\": \\"true\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"AppIds\\": \\"abcd1@abcde123,abcd1@abcde124\\",\\n \\"Namespace\\": \\"prod\\",\\n \\"RecordCanaryDetail\\": true,\\n \\"Id\\": 2047,\\n \\"EntryApp\\": \\"mse:abcd1@a2345\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": true,\\n \\"paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"Paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"canaryModel\\": 0,\\n \\"CanaryModel\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'CreateOrUpdateSwimmingLaneGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateOrUpdateSwimmingLaneGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"1/1\\",\\n \\"LastDirtyTimestamp\\": 20201009115543,\\n \\"IpAddr\\": \\"30.5.XX.XX\\",\\n \\"HomePageUrl\\": \\"http://30.5.XX.XX:8091/\\",\\n \\"HostName\\": \\"30.5.XX.XX\\",\\n \\"InstanceId\\": \\"L-PC1A6A28-****.hz.ali.com:contactinfo:8091\\",\\n \\"Port\\": 8091,\\n \\"SecurePort\\": 443,\\n \\"App\\": \\"CONTACTINFO\\",\\n \\"DurationInSecs\\": 90,\\n \\"LastUpdatedTimestamp\\": 20201010071203,\\n \\"RenewalIntervalInSecs\\": 10,\\n \\"VipAddress\\": \\"contactinfo\\",\\n \\"Metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n202\\n7\\n10\\n请求处理成功\\n316F5F64-F73D-42DC-8632-01E308B6****\\n1\\n\\n 1/1\\n CONTACTINFO\\n 10\\n 443\\n 30.5.XX.XX\\n L-PC1A6A28-****.hz.ali.com:contactinfo:8091\\n 90\\n contactinfo\\n 20201010071203\\n 8091\\n [string]\\n 20201009115543\\n http://30.5.XX.XX:8091/\\n 30.5.XX.XX\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListEurekaInstances', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryMonitor' => [ - 'summary' => 'Queries monitoring information.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreatePluginConfig' => [ + 'summary' => 'Creates a plug-in configuration.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17082', - 'abilityTreeNodes' => [ - 'FEATUREmseZAXYAZ', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '219339', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '', 'description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'], ], [ - 'name' => 'MonitorType', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric type. The following metric types are supported:'."\n" - ."\n" - .'\\[Basic system metrics]'."\n" - ."\n" - .'* cpuUsage'."\n" - .'* memoryUsage'."\n" - .'* diskUsage'."\n" - .'* gcCount'."\n" - .'* gcTime'."\n" - ."\n" - .'\\[Nacos registry]'."\n" - ."\n" - .'* serviceCount'."\n" - .'* writeCostTime'."\n" - .'* readCostTime'."\n" - .'* TPS regCenterTps'."\n" - .'* QPS regCenterQps'."\n" - ."\n" - .'\\[Nacos configuration center]'."\n" - ."\n" - .'* publish'."\n" - .'* getConfig'."\n" - ."\n" - .'\\[zookeeper]'."\n" - ."\n" - .'* TPS zk_TpsCount'."\n" - .'* QPS zk_QpsCount'."\n" - .'* zookeeper_AvgRequestLatency'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'regCenterQps', - ], + 'schema' => ['title' => '', 'description' => 'The gateway plug-in ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], ], [ - 'name' => 'StartTime', + 'name' => 'ConfigLevel', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the monitoring starts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1666678376', - ], + 'schema' => ['title' => '', 'description' => 'The application scope of the plug-in. Valid values:'."\n" + ."\n" + .'* 0: global'."\n" + .'* 1: route'."\n" + .'* 2: domain name'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the monitoring ends.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1666678376', - ], + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The plug-in configuration. The configuration content of the WebAssembly (Wasm) plug-in is in the YAML format. The configuration content of the Lua plug-in is Lua code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'status_code: 200'."\n" + .'headers:'."\n" + .'- Content-Type=application/json'."\n" + .'body: "{\\"rule\\": \\"global\\"}"'], ], [ - 'name' => 'Step', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval between data points. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '7', - ], + 'schema' => ['title' => '', 'description' => 'Indicates whether the plug-in is enabled.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ - 'name' => 'InstanceId', + 'name' => 'ResourceIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The domain IDs or route IDs. They are distinguished based on ConfigLevel.'."\n", + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-****', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'podName' => [ - 'description' => 'The name of the pod.'."\n", - 'type' => 'string', - 'example' => 'mse-xxxxxx-xxxxxx-reg-center-0-0', - ], - 'clusterNamePrefix' => [ - 'description' => 'The prefix of the name.'."\n", - 'type' => 'string', - 'example' => 'mse-xxxx-xxxxxx', - ], - 'values' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The content of the data.'."\n", - 'type' => 'object', - ], - ], - ], - ], - 'example' => '6', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'], + 'PluginConfigID' => ['title' => '', 'description' => 'The plug-in configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"PluginConfigID\\": 10\\n}","type":"json"}]', + 'title' => 'CreatePluginConfig', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreatePluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": [\\n {\\n \\"podName\\": \\"mse-xxxxxx-xxxxxx-reg-center-0-0\\",\\n \\"clusterNamePrefix\\": \\"mse-xxxx-xxxxxx\\",\\n \\"values\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nADDD8AB7-8D1C-4697-A83E-410D2607****\\n请求处理成功\\n6\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'QueryMonitor', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateAcl' => [ - 'summary' => 'Modifies an IP address whitelist.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateSentinelBlockFallbackDefinition' => [ + 'summary' => 'Creates behavior management definitions', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '17096', - 'abilityTreeNodes' => [ - 'FEATUREmse3FEC0V', - ], + 'abilityTreeCode' => '163988', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AclEntryList', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP addresses or CIDR blocks in the IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '192.168.0.0/XX,192.168.0.0/XX', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-app', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'NetworkType', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'default' => 'Public', - 'enum' => [ - 'Private', - 'Public', - ], - ], + 'schema' => ['description' => 'Redundant parameter, currently ignored.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'edasmsc', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The programming language, such as Java or Go.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'JAVA', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Microservices Engine (MSE) namespace.', 'type' => 'string', 'title' => '', 'example' => 'test', 'required' => false], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID, which can be omitted.', 'type' => 'string', 'required' => false, 'example' => 'abcde@12345', 'title' => ''], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => ['description' => 'The scenario, uniformly fill in default.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'ResourceClassification', + 'in' => 'query', + 'schema' => ['description' => 'The target resource type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1 Web'."\n" + .'2 Rpc', 'title' => ''], + ], + [ + 'name' => 'FallbackBehavior', + 'in' => 'query', + 'schema' => ['description' => 'The behavior details.', 'type' => 'string', 'required' => false, 'example' => '{"webFallbackMode":0,"webRespMessage":"{}","webRespStatusCode":429,"webRespContentType":0}', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The behavior name.', 'type' => 'string', 'required' => false, 'example' => 'MyFallback', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want to display the results. Valid values: zh and en. zh is the default value, which indicates Chinese. en indicates English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'ResourceClassification' => ['description' => 'The target resource type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Id' => ['description' => 'The behavior ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '34726', 'title' => ''], + 'Namespace' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Name' => ['description' => 'The behavior name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'FallbackBehavior' => ['description' => 'The behavior details.', 'type' => 'string', 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'OperationNotSupport', - 'errorMessage' => 'The current cluster does not support this operation, %s.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": {\\n \\"ResourceClassification\\": 1,\\n \\"UserId\\": \\"123456\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Id\\": 34726,\\n \\"Namespace\\": \\"default\\",\\n \\"Name\\": \\"test\\",\\n \\"FallbackBehavior\\": \\"{\\\\\\"webRespStatusCode\\\\\\":429,\\\\\\"webRespMessage\\\\\\":\\\\\\"test\\\\\\",\\\\\\"webFallbackMode\\\\\\":0,\\\\\\"webRespContentType\\\\\\":0}\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'CreateSentinelBlockFallbackDefinition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateSentinelBlockFallbackDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\n7466566F-F30F-4A29-965D-3E0AF21D****\\nmse-100-100\\ntrue\\n","errorExample":""}]', - 'title' => 'UpdateAcl', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryInstancesInfo' => [ - 'summary' => 'Queries the runtime data of a specified cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateWebFlowRule' => [ + 'summary' => 'Creates a hotspot parameter protection rule for HTTP requests.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '129092', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '164156', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The namespace', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'default', 'title' => '', 'example' => 'default'], ], [ - 'name' => 'InstanceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl32g1u9k01', - ], + 'schema' => ['description' => 'The application name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'spring-cloud-a'], ], [ - 'name' => 'OrderId', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20574710974****', - ], + 'schema' => ['description' => 'Threshold', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '20'], ], [ - 'name' => 'RegionId', + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region where the instance resides.'."\n", - 'type' => 'string', + 'description' => 'The rule status. Valid values:'."\n" + ."\n" + .'- true: enabled'."\n" + ."\n" + .'- false: disabled', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => 'true', ], ], [ - 'name' => 'RequestPars', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The interface name: The application resources to which the rule applies. The interface name must be the same as the name on the interface details page in the console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '/flow'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Burst', + 'in' => 'query', + 'schema' => ['description' => 'The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens of the token bucket algorithm.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'title' => '', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID', 'type' => 'string', 'required' => false, 'example' => 'hkhon1****@c3df23522******', 'title' => ''], + ], + [ + 'name' => 'ControlBehavior', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" + 'description' => 'The flow control method. Valid values:'."\n" ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + .'- 0: fast failure'."\n" + ."\n" + .'- 2: wait in queue', + 'enumValueTitles' => ['', 2 => ''], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message that is returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'HealthStatus' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Role' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'PodName' => [ - 'description' => 'The pod name.'."\n", - 'type' => 'string', - 'example' => 'mse-xxxxx-xxxxx-reg-center-0-1', - ], - 'Ip' => [ - 'description' => 'The IP address of the pod.'."\n", - 'type' => 'string', - 'example' => '25.24.91.x', - ], - 'InternetIp' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '120.55.71.x', - ], - 'SingleTunnelVip' => [ - 'description' => 'The internal IP address.'."\n", - 'type' => 'string', - 'example' => '172.16.66.x', - ], - 'CreationTimestamp' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-12-15T02:02:15Z', - ], - 'ClientPort' => [ - 'description' => 'The enabled port.'."\n", - 'type' => 'string', - 'example' => '8848', - ], - 'Zone' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - 'ZoneDistributed' => [ - 'description' => 'Indicates whether all pods in the cluster are distributed in the specified zones.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'docRequired' => true, + 'default' => '0', + 'enum' => ['0', '2'], + 'title' => '', + 'example' => '0', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"Data\\": [\\n {\\n \\"HealthStatus\\": \\"null\\",\\n \\"Role\\": \\"null\\",\\n \\"PodName\\": \\"mse-xxxxx-xxxxx-reg-center-0-1\\",\\n \\"Ip\\": \\"25.24.91.x\\",\\n \\"InternetIp\\": \\"120.55.71.x\\",\\n \\"SingleTunnelVip\\": \\"172.16.66.x\\",\\n \\"CreationTimestamp\\": \\"2022-12-15T02:02:15Z\\",\\n \\"ClientPort\\": \\"8848\\",\\n \\"Zone\\": \\"cn-hangzhou-k\\",\\n \\"ZoneDistributed\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'QueryInstancesInfo', - ], - 'QueryClusterInfo' => [ - 'summary' => 'Queries the static information of an instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '129315', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period. Unit: milliseconds. This parameter is required if the ControlBehavior parameter is set to 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '200'], ], - ], - 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'ResourceMode', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', + 'description' => 'Resource mode'."\n" + ."\n" + .'- 0: resource name mode', + 'enumValueTitles' => [''], + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enum' => ['0'], + 'title' => '', + 'example' => '0', ], ], [ - 'name' => 'InstanceId', + 'name' => 'ParamItem', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-7mz2t63ci03', - ], + 'schema' => ['description' => 'The parameter description, which is a JSON string containing the following key-value pairs:'."\n" + ."\n" + .'- parseStrategy: the parameter property (0: client IP address, 1: remote host, 2: header, 3: URL parameter)'."\n" + ."\n" + .'- fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3'."\n" + ."\n" + .'- matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match)'."\n" + ."\n" + .'- pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}'], ], [ - 'name' => 'OrderId', + 'name' => 'MetricType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', + 'description' => 'The threshold type. Valid values:'."\n" + ."\n" + .'- 1 (number of requests)', + 'enumValueTitles' => [1 => ''], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => '20574710974****', + 'enum' => ['1'], + 'title' => '', + 'example' => '1', ], ], [ - 'name' => 'AclSwitch', + 'name' => 'StatIntervalMs', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query the configuration of a public IP address whitelist.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['description' => 'The length of the time window. Unit: milliseconds. The default value is 1000, which indicates 1 second.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1000'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RequestPars', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', + 'description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- 0: custom interface'."\n" + ."\n" + .'- 1: WEB'."\n" + ."\n" + .'- 2: RPC', + 'enumValueTitles' => ['', 'WEB', 'RPC'], + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1', '2', '4', '3'], + 'title' => '', 'required' => false, - 'example' => '{}', + 'example' => '1', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '415088B3-A7BE-56F6-9CD9-C42DE895CD41', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC where the instance resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1v5nbauzh8xxxxxxx', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2022-12-15 10:02:07', - ], - 'IntranetAddress' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'DiskType' => [ - 'description' => 'A deprecated parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'PubNetworkFlow' => [ - 'description' => 'The public bandwidth. Unit: Mbit/s.\\'."\n" - .'Valid values: 0 to 5000. The value 0 indicates no access to the Internet.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DiskCapacity' => [ - 'description' => 'A deprecated parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'MemoryCapacity' => [ - 'description' => 'A deprecated parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'ClusterAliasName' => [ - 'description' => 'The alias of the instance.'."\n", - 'type' => 'string', - 'example' => 'Development environment'."\n", - ], - 'InstanceCount' => [ - 'description' => 'The number of instance nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'IntranetPort' => [ - 'description' => 'The instance ports that are accessible over an internal network.'."\n", - 'type' => 'string', - 'example' => '8848,6443,9848,8761', - ], - 'InstanceModels' => [ - 'description' => 'The reserved structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The reserved structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'PodName' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'SingleTunnelVip' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'InternetIp' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Ip' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Role' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'HealthStatus' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'CreationTimestamp' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Zone' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - 'IntranetDomain' => [ - 'description' => 'The internal endpoint.'."\n", - 'type' => 'string', - 'example' => 'mse-xxxxx-nacos-ans.mse.aliyuncs.com', - ], - 'InternetDomain' => [ - 'description' => 'The public endpoint.'."\n", - 'type' => 'string', - 'example' => 'mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com', - ], - 'PayInfo' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'Pay-as-you-go'."\n", - ], - 'InternetAddress' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'AclEntryList' => [ - 'description' => 'The public IP address whitelist.'."\n", - 'type' => 'string', - 'example' => '["127.0.0.0/32"]', - ], - 'HealthStatus' => [ - 'description' => 'The status of the instance.'."\n", - 'type' => 'string', - 'example' => 'INIT_SUCCESS', - ], - 'InitCostTime' => [ - 'description' => 'The time that is required to initialize the instance. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53353', - ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AclId' => [ - 'description' => 'The ID of the instance in the public IP address whitelist.'."\n", - 'type' => 'string', - 'example' => 'acl-bp144q24cgqvzckmxxxx', - ], - 'Cpu' => [ - 'description' => 'A deprecated parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'ClusterType' => [ - 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'ClusterName' => [ - 'description' => 'The full name of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-74355150-xxxxxxx', - ], - 'InitStatus' => [ - 'description' => 'The initial status of the instance.'."\n", - 'type' => 'string', - 'example' => 'INIT_SUCCESS', - ], - 'InternetPort' => [ - 'description' => 'The instance ports that are accessible over the Internet.'."\n", - 'type' => 'string', - 'example' => '8848,6443,9848,8761', - ], - 'AppVersion' => [ - 'description' => 'The version of the instance.'."\n", - 'type' => 'string', - 'example' => '2.1.0', - ], - 'NetType' => [ - 'description' => 'The network connection type of the instance.'."\n", - 'type' => 'string', - 'example' => 'privatenet', - ], - 'ClusterVersion' => [ - 'description' => 'The version of the order.'."\n", - 'type' => 'string', - 'example' => 'NACOS_2_0_0', - ], - 'ClusterSpecification' => [ - 'description' => 'The engine specifications.'."\n", - 'type' => 'string', - 'example' => 'MSE_SC_2_4_60_c', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1egfakxxxxx', - ], - 'ConnectionType' => [ - 'description' => 'A deprecated parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'MseVersion' => [ - 'description' => 'The version of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse_pro', - ], - 'ChargeType' => [ - 'title' => '', - 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'Tags' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - ], - 'ExpectZones' => [ - 'description' => 'The zones to which the current cluster can be distributed.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - ], - 'MaintenancePeriod' => [ - 'description' => 'The O\\&M time window.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The start time of the O\\&M time window.'."\n", - 'type' => 'string', - 'example' => '02:00', - ], - 'StartTime' => [ - 'description' => 'The end time of the O\\&M time window.'."\n", - 'type' => 'string', - 'example' => '06:00', - ], - ], - ], - 'EndDate' => [ - 'title' => '到期时间（包年包月）', - 'description' => 'The time when the subscription instance expires.'."\n", - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'SecurityGroupId' => [ - 'title' => 'ENI网络接入的安全组ID', - 'description' => 'The ID of the security group to which the elastic network interface (ENI) is connected.'."\n", - 'type' => 'string', - 'example' => 'sg-uf6hgwe067prhg68agfa', - ], - 'SecurityGroupType' => [ - 'title' => 'ENI网络接入的安全组类型', - 'description' => 'The type of the security group to which the ENI is connected.'."\n", - 'type' => 'string', - 'example' => 'enterprise', - 'enum' => [ - 'enterprise', - 'normal', - ], - ], - 'EipInstanceId' => [ - 'title' => '弹性公网IP（EIP）的实例ID', - 'description' => 'The ID of the instance that is associated with the Elastic IP Address (EIP).'."\n", - 'type' => 'string', - 'example' => 'eip-bp1uujshd5funmyy8rcl9', - ], - 'CanUpdate' => [ - 'type' => 'boolean', - ], - 'VersionCode' => [ - 'type' => 'string', - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'StatIntervalMs' => ['description' => 'The length of the time window. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Resource' => ['description' => 'Interface name: the application resources to which the rule applies. The interface name must be the same as that displayed on the API details page in the console.', 'type' => 'string', 'example' => '/flow', 'title' => ''], + 'ControlBehavior' => ['description' => 'The flow control method. Valid values:'."\n" + ."\n" + .'- 0: fast failure'."\n" + ."\n" + .'- 2: wait in queue', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ReourceMode' => ['description' => 'Resource mode'."\n" + ."\n" + .'0: resource name mode', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MaxQueueingTimeMs' => ['description' => 'The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Threshold' => ['description' => 'The threshold.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + 'Enable' => ['description' => 'The rule status. Valid values:'."\n" + ."\n" + .'- true: enabled'."\n" + ."\n" + .'- false: disabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1****@c3df23522******', 'title' => ''], + 'MetricType' => ['description' => 'The threshold type. Valid values:'."\n" + ."\n" + .'- 1: number of requests', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Burst' => ['description' => 'The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens of the token bucket algorithm.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParamItem' => ['description' => 'The parameter description, which is a JSON string containing the following key-value pairs:'."\n" + ."\n" + .'- parseStrategy: the parameter property (0: client IP address, 1: remote host, 2: header, 3: URL parameter)'."\n" + ."\n" + .'- fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3'."\n" + ."\n" + .'- matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match)'."\n" + ."\n" + .'- pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched', 'type' => 'string', 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ControlBehavior\\": 0,\\n \\"ReourceMode\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1****@c3df23522******\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Burst\\": 0,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateWebFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"415088B3-A7BE-56F6-9CD9-C42DE895CD41\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-bp1v5nbauzh8xxxxxxx\\",\\n \\"CreateTime\\": \\"2022-12-15 10:02:07\\",\\n \\"IntranetAddress\\": \\"null\\",\\n \\"DiskType\\": \\"null\\",\\n \\"PubNetworkFlow\\": \\"1\\",\\n \\"DiskCapacity\\": 0,\\n \\"MemoryCapacity\\": 0,\\n \\"ClusterAliasName\\": \\"开发环境\\",\\n \\"InstanceCount\\": 3,\\n \\"IntranetPort\\": \\"8848,6443,9848,8761\\",\\n \\"InstanceModels\\": [\\n {\\n \\"PodName\\": \\"null\\",\\n \\"SingleTunnelVip\\": \\"null\\",\\n \\"InternetIp\\": \\"null\\",\\n \\"Ip\\": \\"null\\",\\n \\"Role\\": \\"null\\",\\n \\"HealthStatus\\": \\"null\\",\\n \\"CreationTimestamp\\": \\"null\\",\\n \\"Zone\\": \\"null\\"\\n }\\n ],\\n \\"IntranetDomain\\": \\"mse-xxxxx-nacos-ans.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com\\",\\n \\"PayInfo\\": \\"按量付费\\",\\n \\"InternetAddress\\": \\"null\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"AclEntryList\\": \\"[\\\\\\"127.0.0.0/32\\\\\\"]\\",\\n \\"HealthStatus\\": \\"INIT_SUCCESS\\",\\n \\"InitCostTime\\": 53353,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AclId\\": \\"acl-bp144q24cgqvzckmxxxx\\",\\n \\"Cpu\\": 0,\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"ClusterName\\": \\"mse-74355150-xxxxxxx\\",\\n \\"InitStatus\\": \\"INIT_SUCCESS\\",\\n \\"InternetPort\\": \\"8848,6443,9848,8761\\",\\n \\"AppVersion\\": \\"2.1.0\\",\\n \\"NetType\\": \\"privatenet\\",\\n \\"ClusterVersion\\": \\"NACOS_2_0_0\\",\\n \\"ClusterSpecification\\": \\"MSE_SC_2_4_60_c\\",\\n \\"VSwitchId\\": \\"vsw-bp1egfakxxxxx\\",\\n \\"ConnectionType\\": \\"null\\",\\n \\"MseVersion\\": \\"mse_pro\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExpectZones\\": [\\n \\"cn-hangzhou-k\\"\\n ],\\n \\"MaintenancePeriod\\": {\\n \\"EndTime\\": \\"02:00\\",\\n \\"StartTime\\": \\"06:00\\"\\n },\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"SecurityGroupId\\": \\"sg-uf6hgwe067prhg68agfa\\",\\n \\"SecurityGroupType\\": \\"enterprise\\",\\n \\"EipInstanceId\\": \\"eip-bp1uujshd5funmyy8rcl9\\",\\n \\"CanUpdate\\": true,\\n \\"VersionCode\\": \\"NACOS_2_1_0_1\\",\\n \\"VersionLifecycle\\": \\"\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'QueryClusterInfo', ], - 'QueryClusterDetail' => [ - 'summary' => 'Queries the details of an instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateZnode' => [ + 'summary' => 'Creates a znode.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17078', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '17007', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ - 'name' => 'OrderId', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '20576750143****', - ], + 'schema' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '/zookeeper', 'title' => ''], ], [ - 'name' => 'AclSwitch', + 'name' => 'Data', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query access control lists (ACLs).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'data', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The string object.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1hcg467ekqsv0zr****', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2020-07-31 11:36:08', - ], - 'IntranetAddress' => [ - 'description' => 'The internal IP address.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'DiskType' => [ - 'description' => 'The type of the disk.'."\n", - 'type' => 'string', - 'example' => 'alicloud-disk-ssd-multi-zone', - ], - 'PubNetworkFlow' => [ - 'description' => 'The public bandwidth. Unit: Mbit/s.\\'."\n" - .'Valid values: 0 to 5000. The value 0 indicates no access to the Internet.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'DiskCapacity' => [ - 'description' => 'The capacity of the disk. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'MemoryCapacity' => [ - 'description' => 'The size of the memory. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ClusterAliasName' => [ - 'description' => 'The alias of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****', - ], - 'InstanceCount' => [ - 'description' => 'The number of instance nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'IntranetPort' => [ - 'description' => 'The private port number.'."\n", - 'type' => 'string', - 'example' => '8761', - ], - 'InstanceModels' => [ - 'description' => 'The list of instance nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The string object.'."\n", - 'type' => 'object', - 'properties' => [ - 'PodName' => [ - 'description' => 'The name of the pod.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****-159616656****-reg-center-0-0', - ], - 'SingleTunnelVip' => [ - 'description' => 'The single-thread IP address.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'InternetIp' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '47.98.XX.XX', - ], - 'Ip' => [ - 'description' => 'The IP address of the instance.'."\n", - 'type' => 'string', - 'example' => '10.12.XX.XX', - ], - 'Role' => [ - 'description' => 'The role.'."\n", - 'type' => 'string', - 'example' => 'Peer', - ], - 'HealthStatus' => [ - 'description' => 'The health status of the instance.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'CreationTimestamp' => [ - 'description' => 'The timestamp when the instance was created.'."\n", - 'type' => 'string', - 'example' => '1578575377732', - ], - 'Zone' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai-f', - ], - ], - ], - ], - 'IntranetDomain' => [ - 'description' => 'The internal endpoint of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', - ], - 'InternetDomain' => [ - 'description' => 'The public endpoint of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', - ], - 'PayInfo' => [ - 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'Pay-as-you-go'."\n", - ], - 'InternetAddress' => [ - 'description' => 'The public IP address of the instance.'."\n", - 'type' => 'string', - 'example' => '47.98.XX.XX', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'AclEntryList' => [ - 'description' => 'The whitelist.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'HealthStatus' => [ - 'description' => 'The health status of the instance.'."\n", - 'type' => 'string', - 'example' => 'RESTART_SUCCESS', - ], - 'InitCostTime' => [ - 'description' => 'The amount of time taken to create the instance. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98408', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AclId' => [ - 'description' => 'The ID of the whitelist.'."\n", - 'type' => 'string', - 'example' => 'acl-bp17020kiqvzutwwj****', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ClusterType' => [ - 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'ClusterName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****', - ], - 'InitStatus' => [ - 'description' => 'The creation status of the instance.'."\n", - 'type' => 'string', - 'example' => 'RESTART_SUCCESS', - ], - 'InternetPort' => [ - 'description' => 'The private port number.'."\n", - 'type' => 'string', - 'example' => '8761', - ], - 'AppVersion' => [ - 'description' => 'The application version.'."\n", - 'type' => 'string', - 'example' => '1.2.1', - ], - 'NetType' => [ - 'description' => 'The network type of the instance. Valid values:'."\n" - ."\n" - .'* `privatenet`: VPC'."\n" - .'* `pubnet`: Internet'."\n", - 'type' => 'string', - 'example' => 'privatenet', - ], - 'ClusterVersion' => [ - 'description' => 'The version of the instance.'."\n", - 'type' => 'string', - 'example' => '1.2.1', - ], - 'ClusterSpecification' => [ - 'description' => 'The engine specifications.'."\n", - 'type' => 'string', - 'example' => 'MSE_SC_1_2_200_c', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-xxx-xxxx', - ], - 'ConnectionType' => [ - 'description' => 'The network connection type. Valid values:'."\n" - ."\n" - .'* slb'."\n" - .'* eni'."\n", - 'type' => 'string', - 'example' => 'slb', - ], - 'MseVersion' => [ - 'description' => 'The edition of Microservices Engine (MSE).'."\n", - 'type' => 'string', - 'example' => 'mse_basic', - ], - 'ChargeType' => [ - 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'Pay-as-you-go'."\n", - ], - 'OrderClusterVersion' => [ - 'description' => 'The version number of the original order.'."\n", - 'type' => 'string', - 'example' => '1.2.0', - ], - 'Tags' => [ - 'description' => 'The tags that are attached to the instance.'."\n", - 'type' => 'object', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2dhgysj*****', - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'Path' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'example' => '/', 'title' => ''], + 'Dir' => ['description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => 'The current ZooKeeper operation is invalid, please recheck and perform the operation.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => 'No permission to operate the current node.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => 'The current node already exists. Please check and try again.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => 'The currently operating node does not exist and may have been deleted.'], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper the operation times out, it may be because the current Znode data is too large, there are too many child nodes, the server takes too long to process the request, or the cluster is currently selecting a host and cannot process the request.'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"9515ACA4-E94D-440D-989E-C379FCED****\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-bp1hcg467ekqsv0zr****\\",\\n \\"CreateTime\\": \\"2020-07-31 11:36:08\\",\\n \\"IntranetAddress\\": \\"192.168.XX.XX\\",\\n \\"DiskType\\": \\"alicloud-disk-ssd-multi-zone\\",\\n \\"PubNetworkFlow\\": \\"3\\",\\n \\"DiskCapacity\\": 60,\\n \\"MemoryCapacity\\": 2,\\n \\"ClusterAliasName\\": \\"mse-7413****\\",\\n \\"InstanceCount\\": 3,\\n \\"IntranetPort\\": \\"8761\\",\\n \\"InstanceModels\\": [\\n {\\n \\"PodName\\": \\"mse-7413****-159616656****-reg-center-0-0\\",\\n \\"SingleTunnelVip\\": \\"192.168.XX.XX\\",\\n \\"InternetIp\\": \\"47.98.XX.XX\\",\\n \\"Ip\\": \\"10.12.XX.XX\\",\\n \\"Role\\": \\"Peer\\",\\n \\"HealthStatus\\": \\"Running\\",\\n \\"CreationTimestamp\\": \\"1578575377732\\",\\n \\"Zone\\": \\"cn-shanghai-f\\"\\n }\\n ],\\n \\"IntranetDomain\\": \\"mse-7413****-eureka.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-7413****-p.eureka.mse.aliyuncs.com\\",\\n \\"PayInfo\\": \\"按量付费\\",\\n \\"InternetAddress\\": \\"47.98.XX.XX\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"AclEntryList\\": \\"[]\\",\\n \\"HealthStatus\\": \\"RESTART_SUCCESS\\",\\n \\"InitCostTime\\": 98408,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AclId\\": \\"acl-bp17020kiqvzutwwj****\\",\\n \\"Cpu\\": 1,\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"ClusterName\\": \\"mse-bc1a29b0-160230875****\\",\\n \\"InitStatus\\": \\"RESTART_SUCCESS\\",\\n \\"InternetPort\\": \\"8761\\",\\n \\"AppVersion\\": \\"1.2.1\\",\\n \\"NetType\\": \\"privatenet\\",\\n \\"ClusterVersion\\": \\"1.2.1\\",\\n \\"ClusterSpecification\\": \\"MSE_SC_1_2_200_c\\",\\n \\"VSwitchId\\": \\"vsw-xxx-xxxx\\",\\n \\"ConnectionType\\": \\"slb\\",\\n \\"MseVersion\\": \\"mse_basic\\",\\n \\"ChargeType\\": \\"按量付费\\",\\n \\"OrderClusterVersion\\": \\"1.2.0\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ResourceGroupId\\": \\"rg-aek2dhgysj*****\\",\\n \\"VersionLifecycle\\": \\"\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nE7744898-AF7E-4FBC-9123-EAF01CFA****\\n请求处理成功\\n\\n 47.98.XX.XX\\n []\\n 1\\n 8761\\n 8761\\n 1.9.3\\n alicloud-disk-ssd-multi-zone\\n 按量付费\\n 98408\\n mse-74131be0-159616656****\\n mse-7413****-eureka.mse.aliyuncs.com\\n mse-7413****\\n mse-cn-st21ri2****\\n mse-7413****-p.eureka.mse.aliyuncs.com\\n 2020-07-31 11:36:08\\n acl-bp17020kiqvzutwwj****\\n RESTART_SUCCESS\\n Eureka\\n 2\\n mse-7413****\\n \\n Peer\\n mse-7413****-159616656****-reg-center-0-0\\n 47.98.XX.XX\\n mse-cn-st21ri2****\\n mse-7413****\\n 192.168.XX.XX\\n 10.12.XX.XX\\n Running\\n xxx\\n XXX\\n 2181\\n \\n 3\\n 192.168.XX.XX\\n 60\\n vpc-bp1hcg467ekqsv0zr****\\n 3\\n cn-hangzhou\\n RESTART_SUCCESS\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'QueryClusterDetail', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateZnode', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateCluster' => [ - 'summary' => 'Create an MSE registration and configuration center instance', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteAuthResource' => [ + 'summary' => 'Deletes an authorized resource.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -12092,458 +7793,210 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '17002', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '37111', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'PubNetworkFlow', - 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionType为`slb`时有效，0表示不创建公网接入SLB，1以上值表示公网接入SLB的带宽固定值；单位Mbps', - 'description' => 'Valid when `ConnectionType` is `slb`. 0 indicates no public network access SLB creation, and values above 1 indicate a fixed bandwidth for public network access SLB; unit: Mbps.'."\n" - ."\n" - .'Value range: 0~5000.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'PubSlbSpecification', - 'in' => 'query', - 'schema' => [ - 'title' => '不再使用', - 'description' => 'No longer in use', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => 'slb.s1.small', - ], - ], - [ - 'name' => 'DiskType', - 'in' => 'query', - 'schema' => [ - 'title' => '不再使用', - 'description' => 'No longer in use', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => 'alicloud-disk-ssd', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vpc-bp1t50e045b5g7i3p****', - ], - ], - [ - 'name' => 'NetType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Network type, with the following values:'."\n" - .'- `privatenet`: indicates a private network.'."\n" - .'- `pubnet`: indicates a public network.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'privatenet', - ], - ], - [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Switch ID.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vsw-bp17opt4v18sto39k****', - ], - ], - [ - 'name' => 'InstanceCount', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '实例节点数，开发版仅支持1节点，其它版本支持3-9单数节点', - 'description' => 'Number of instance nodes, with a range limit of 1 to 9.'."\n" - ."\n" - .'[Professional Edition] '."\n" - .'- The number of instances must be 3 or more and must be an odd number.'."\n" - ."\n" - .'[Developer Edition] '."\n" - .'- The number of instances can only be 1.'."\n" - ."\n" - .'[Serverless Edition]'."\n" - ."\n" - .'Ignore this parameter.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The destination ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '36', 'title' => ''], ], [ - 'name' => 'ClusterSpecification', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'Engine specifications, with the following values:'."\n" - ."\n" - .'[Professional Edition] '."\n" - ."\n" - .'- `MSE_SC_2_4_60_c`: 2 cores, 4GB'."\n" - .'- `MSE_SC_1_2_60_c`: 1 core, 2GB'."\n" - .'- `MSE_SC_4_8_60_c`: 4 cores, 8GB'."\n" - .'- `MSE_SC_8_16_60_c`: 8 cores, 16GB'."\n" - .'- `MSE_SC_16_32_60_c`: 16 cores, 32GB'."\n" - ."\n" - .'[Developer Edition] '."\n" - ."\n" - .'- `MSE_SC_1_2_60_c`: 1 core, 2GB'."\n" - .'- `MSE_SC_2_4_60_c`: 2 cores, 4GB'."\n" - ."\n" - .'[Serverless Edition]'."\n" - ."\n" - .'Ignore this parameter, or you can fill in `MSE_SC_SERVERLESS`.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MSE_SC_2_4_60_c', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', 'title' => ''], ], [ - 'name' => 'ClusterVersion', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'Cluster version, with the following values:'."\n" - ."\n" - .'[Professional Edition] '."\n" - ."\n" - .'- `NACOS_2_0_0`: indicates Nacos 2.x.x version.'."\n" - .'- `ZooKeeper_3_8_0`: indicates ZooKeeper 3.8.x version.'."\n" - ."\n" - .'[Developer Edition] '."\n" - ."\n" - .'- `NACOS_2_0_0`: indicates Nacos 2.x version.'."\n" - .'- `ZooKeeper_3_8_0`: indicates ZooKeeper 3.8.x version.'."\n" - ."\n" - .'[Serverless Edition]'."\n" - ."\n" - .'- `NACOS_2_0_0`: indicates Nacos 2.x version.'."\n" - .'- `ZooKeeper_3_8_0`: indicates ZooKeeper 3.8.x version.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NACOS_2_0_0', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'ClusterType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Cluster type, including ZooKeeper, Nacos-Ans.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Nacos-Ans', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '559412D1-BFCE-53CC-B88E-0192C331EF44'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the primary key.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'AuthId' => ['description' => 'The authentication ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '253', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', 'title' => ''], + 'GatewayId' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', 'title' => ''], + 'DomainId' => ['description' => 'The ID of the domain name.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '235', 'title' => ''], + 'DomainName' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Path' => ['description' => 'The path.'."\n", 'type' => 'string', 'example' => '/zookeeper', 'title' => ''], + 'IsWhite' => ['description' => 'Indicates whether the whitelist mode is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the cluster is located, including but not limited to the following regions:'."\n" - .'- `cn-hangzhou`: Hangzhou'."\n" - .'- `cn-beijing`: Beijing'."\n" - .'- `cn-shanghai`: Shanghai'."\n" - .'- `cn-zhangjiakou`: Zhangjiakou'."\n" - .'- `cn-shenzhen`: Shenzhen', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], - [ - 'name' => 'PrivateSlbSpecification', - 'in' => 'query', - 'schema' => [ - 'title' => '不再使用', - 'description' => 'No longer in use', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => 'slb.s1.small', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'ConnectionType', - 'in' => 'query', - 'schema' => [ - 'title' => '网络接入类型，`slb`或`single_eni`；部分Region开发版只支持`single_eni`类型', - 'description' => 'Network access type, `slb` or `single_eni`; some regions\' Developer Edition only support the `single_eni` type.', - 'type' => 'string', - 'required' => false, - 'example' => 'slb', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'Extended request parameters, in JSON format.', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"559412D1-BFCE-53CC-B88E-0192C331EF44\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"AuthId\\": 253,\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 0,\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"name\\",\\n \\"Path\\": \\"/zookeeper\\",\\n \\"IsWhite\\": true,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteAuthResource', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'MseVersion', - 'in' => 'query', - 'schema' => [ - 'title' => '实例版本：开发版mse_dev、基础版mse_basic、专业版mse_pro', - 'description' => 'Required unless under special circumstances, with the following values:'."\n" - ."\n" - .'- `mse_pro`: indicates Professional Edition.'."\n" - .'- `mse_dev`: indicates Developer Edition.'."\n" - .'- `mse_serverless`: indicates Serverless Edition.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'mse_dev' => '开发版', - 'mse_serverless' => 'Serverless版', - 'mse_pro' => '专业版', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteAuthResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - 'example' => 'mse_pro', ], ], + ], + ], + 'DeleteCircuitBreakerRules' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'InstanceName', - 'in' => 'query', - 'schema' => [ - 'title' => '实例别名', - 'description' => 'Custom instance name', - 'type' => 'string', - 'required' => false, - 'example' => 'tanshuyingtest001', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '167824', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID. For more details about the resource group, see [Basic Information of Resource Group](~~457230~~).', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzcqmoay3dlyq', - ], + 'schema' => ['title' => '', 'description' => 'The microservice namespace to which the application belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'Tag', + 'name' => 'Ids', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => 'List of tags to be added. Contains up to 20 items.', + 'title' => '', + 'description' => 'The IDs of the rules that you want to delete.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'Tag.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'Tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], - ], - [ - 'name' => 'ChargeType', - 'in' => 'query', - 'schema' => [ - 'title' => '付费类型', - 'description' => 'Billing method, including PREPAY (Subscription) and POSTPAY (Pay-As-You-Go).'."\n" - ."\n" - .'This parameter is ignored for the Serverless edition.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PREPAY' => '包年包月', - 'POSTPAY' => '按量付费', - ], - 'example' => 'POSTPAY', - ], - ], - [ - 'name' => 'SecurityGroupType', - 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionType为`single_eni`时有效，表示实例所在的安全组类型', - 'description' => 'Valid when `ConnectionType` is `single_eni`, indicating the security group type of the instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'enterprise', - 'default' => 'enterprise', - 'enum' => [ - 'enterprise', - 'normal', - ], + 'items' => ['title' => '', 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, ], ], [ - 'name' => 'EipEnabled', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionType为`single_eni`时有效，表示是否开启公网访问（弹性公网IP）', - 'description' => 'Valid when `ConnectionType` is `single_eni`, indicating whether to enable public network access (Elastic IP).', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'default' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language type of the returned information:'."\n" - ."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'String object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'dc63-465d-8ef5-20dc18af****', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'InstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ErrorCode' => [ - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'OrderId' => [ - 'description' => 'Order ID.', - 'type' => 'string', - 'example' => '20574710974****', - ], - 'Success' => [ - 'description' => 'Request result, with the following values:'."\n" - .'- `true`: Request succeeded.'."\n" - .'- `false`: Request failed.', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The IDs of the rules that were deleted.'."\n", + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"FAF577DD-8E8E-5BE6-80CC-380E19******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteCircuitBreakerRules', + 'summary' => 'Deletes circuit breaking rules.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"OrderId\\": \\"20574710974****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n dc63-465d-8ef5-20dc18af****\\n 请求处理成功\\n mse-cn-st21ri2****\\n mse-100-000\\n 20574710974****\\n true\\n","errorExample":""}]', - 'title' => 'Create Registration and Configuration Center Cluster', - 'description' => 'Please ensure that you fully understand the billing method and pricing of the MSE (Microservice Engine) product before using this interface.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - 'translator' => 'machine', ], 'DeleteCluster' => [ 'summary' => 'Deletes a Microservices Engine (MSE) instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -12554,35 +8007,21 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '17009', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-6ja1rgl****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-6ja1rgl****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -12591,256 +8030,153 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n202\\n3369AD10-F1A6-4E6F-B99E-20F51826****\\n请求处理成功\\nmse-100-000\\ntrue\\n","errorExample":""}]', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => 'DeleteCluster', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateCluster' => [ - 'summary' => 'Modifies the information about an instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteEngineNamespace' => [ + 'summary' => 'Deletes a namespace from a Nacos instance.', + 'methods' => ['post', 'get', 'delete'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17098', - 'abilityTreeNodes' => [ - 'FEATUREmseY3D6DK', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '17010', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'ClusterAliasName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The alias of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cluster-1', - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '678ca857-****-b1bf-d0a98c5ca84b', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], - ], - [ - 'name' => 'MaintenanceStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the O\\&M window.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '02:00', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-7pp2d1****', 'title' => ''], ], [ - 'name' => 'MaintenanceEndTime', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the O\\&M window.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '06:00', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-0c738****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteEngineNamespace', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\n5B170A0D-2C5D-4CF8-B808-03966B86****\\nmse-100-100\\ntrue\\n","errorExample":""}]', - 'title' => 'UpdateCluster', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateConfig' => [ - 'summary' => 'Updates the configurations of an instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteFlowRules' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -12849,1430 +8185,955 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '17099', - 'abilityTreeNodes' => [ - 'FEATUREmseY3D6DK', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '159871', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '', 'description' => 'The microservice namespace to which the application belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'ClusterId', + 'name' => 'Ids', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'The IDs of the rules to be deleted.'."\n", + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => true, 'docRequired' => true, - 'example' => 'mse-09k1q11****', + 'example' => '[1,2]', ], ], [ - 'name' => 'ConfigType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The format of the configuration. Supported formats include TEXT, JSON, XML, and HTML.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TEXT', - ], + 'schema' => ['title' => '', 'description' => 'The application name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'TickTime', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The time unit. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2000', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'InitLimit', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The maximum connection duration of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '100', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The IDs of the rules that were deleted.'."\n", + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'SyncLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"FAF577DD-8E8E-5BE6-80CC-380E19******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteFlowRules', + 'summary' => 'Deletes throttling rules.', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'MaxClientCnxns', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of connections between a client and a server. This parameter is valid for ZooKeeper instances.\\'."\n" - .'If this parameter is set to 0, no limits are imposed on the number of connections.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteGateway' => [ + 'summary' => 'Deletes a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'OpenSuperAcl', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable super permissions. This parameter is valid for ZooKeeper instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '24808', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], + ], + 'parameters' => [ [ - 'name' => 'UserName', + 'name' => 'DeleteSlb', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the user.'."\n" - ."\n" - .'> You must specify this parameter if OpenSuperAcl is set to true.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => 'Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PassWord', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password that corresponds to the username.'."\n" - ."\n" - .'> You must specify this parameter if OpenSuperAcl is set to true.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'password', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0fe488252dc44d55a9dd57875193a1d7', 'title' => ''], ], [ - 'name' => 'JuteMaxbuffer', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. The default maximum data amount on each node is 1 megabyte. Unit: bytes.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1048575', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'AutopurgePurgeInterval', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'none', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the primary key.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Name' => ['description' => 'The name of the gateway.'."\n", 'type' => 'string', 'example' => 'mse-bc1a29b0-reg-center-0-1', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway. The ID is automatically generated by the system.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****', 'title' => ''], + 'Region' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'PrimaryUser' => ['description' => 'The information about the user.'."\n", 'type' => 'string', 'example' => '1231254', 'title' => ''], + 'Status' => ['description' => 'The status of the gateway. Valid values: 0: The gateway is being created. 1: The gateway fails to be created. 2: The gateway is running. 3: The gateway is changing. 4: The gateway is scaling down. 6: The gateway is scaling up. 8: The gateway is being deleted. 10: The gateway is restarting. 11: The gateway is being rebuilt. 12: The gateway is updating. 13: The gateway fails to be updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Vpc' => ['description' => 'The ID of the virtual private cloud (VPC) where the gateway resides.'."\n", 'type' => 'string', 'example' => 'vpc-bp1328cm01m6uel42b5zb', 'title' => ''], + 'Vswitch' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', 'title' => ''], + 'SecurityGroup' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'example' => 'sg-bp11ufzqn6mmb8dtzz82', 'title' => ''], + 'Spec' => ['description' => 'The specifications of the gateway.'."\n", 'type' => 'string', 'example' => 'MSE_GTW_16_32_200_c', 'title' => ''], + 'Replica' => ['description' => 'The number of gateway replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the gateway was last updated.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'AutopurgeSnapRetainCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'none', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], - [ - 'name' => 'ConfigAuthEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable Resource Access Management (RAM) authentication for a configuration center. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n" - ."\n" - .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the ConfigAuthSupported parameter value to check whether the instance supports the RAM authentication feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'NamingAuthEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable RAM authentication for a registry. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n" - ."\n" - .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the NamingAuthSupporte parameter value to check whether the instance supports the RAM authentication feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], - [ - 'name' => 'MCPEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable Mesh Configuration Protocol (MCP). This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n" - ."\n" - .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the MCPSupported parameter value to check whether the instance supports MCP.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"mse-bc1a29b0-reg-center-0-1\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"1231254\\",\\n \\"Status\\": 1,\\n \\"Vpc\\": \\"vpc-bp1328cm01m6uel42b5zb\\",\\n \\"Vswitch\\": \\"vsw-bp18zeqxx6mpuq843z4n5\\",\\n \\"SecurityGroup\\": \\"sg-bp11ufzqn6mmb8dtzz82\\",\\n \\"Spec\\": \\"MSE_GTW_16_32_200_c\\",\\n \\"Replica\\": 2,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGateway', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-st2212****', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGateway', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'DeleteGatewayAuthConsumer' => [ + 'summary' => 'Deletes a consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ConfigSecretEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable configuration encryption for a configuration center. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n" - ."\n" - .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the ConfigSecretSupported parameter value to check whether the instance supports configuration encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'MinSessionTimeout', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '最小超时时间', - 'description' => 'The minimum timeout period. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', 'title' => ''], ], [ - 'name' => 'MaxSessionTimeout', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '最大超时时间', - 'description' => 'The maximum timeout period. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The ID of the consumer on which the gateway performs authentication operations.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', 'title' => ''], ], [ - 'name' => 'SnapshotCount', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The frequency for generating snapshots. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100000', + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the execution was successful. Valid values:'."\n" + ."\n" + .'* true: The execution was successful.'."\n" + .'* false: The execution failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'ExtendedTypesEnable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the time to live (TTL) configuration. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayAuthConsumer', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'EurekaSupported', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'DeleteGatewayAuthConsumerResource' => [ + 'summary' => 'Deletes resource permissions from the consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'TLSEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ConsoleUIEnabled', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", 'title' => ''], ], [ - 'name' => 'Enable4lw', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The consumer ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'AuthEnabled', + 'name' => 'IdList', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The IDs of the authorized resources that you want to delete.'."\n", 'type' => 'string', 'required' => true, 'example' => '1,2,3,4', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayAuthConsumerResource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayAuthConsumerResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\nCB889254-0C8B-49B2-8465-4CDAB08A****\\n请求处理成功\\nmse-100-100\\ntrue\\n","errorExample":""}]', - 'title' => 'UpdateConfig', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListClusters' => [ - 'summary' => 'Queries Microservices Engine (MSE) instances.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayCircuitBreakerRule' => [ + 'summary' => 'Deletes a gateway circuit breaking rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17063', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11151', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the circuit breaking rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ClusterAliasName', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The alias of the instance. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cluster', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], - [ - 'name' => 'RegionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Data' => ['description' => 'The response data.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group. For more information about resource groups, see the topic "View basic information of a resource group."'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxbzafebvvfa', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayCircuitBreakerRule', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags. A maximum number of 20 tags are supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 21, ], ], + ], + ], + 'DeleteGatewayDomain' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'KeyId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '35642', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], + ], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The domain ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '109'], ], [ - 'name' => 'VpcId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-90392d768a3847a7b804c505254d****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '39016EAC-6EDB-52FE-AE20-4B013DF236FF'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The string object.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndDate' => [ - 'description' => 'The time when the cluster expires.'."\n", - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'IntranetDomain' => [ - 'description' => 'The internal endpoint.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', - ], - 'InternetDomain' => [ - 'description' => 'The public endpoint.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', - ], - 'CreateTime' => [ - 'description' => 'The time when the cluster was created.'."\n", - 'type' => 'string', - 'example' => '2020-07-31 11:36:08', - ], - 'ChargeType' => [ - 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'Pay-as-you-go'."\n", - ], - 'IntranetAddress' => [ - 'description' => 'The internal IP address.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'InternetAddress' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '47.98.XX.XX', - ], - 'ClusterAliasName' => [ - 'description' => 'The alias of the cluster.'."\n", - 'type' => 'string', - 'example' => 'mse-7413****', - ], - 'ClusterType' => [ - 'description' => 'The type of the cluster. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", - 'type' => 'string', - 'example' => 'Eureka', - ], - 'InitStatus' => [ - 'description' => 'The initialization status of the instance.'."\n", - 'type' => 'string', - 'example' => 'RESTART_SUCCESS', - ], - 'AppVersion' => [ - 'description' => 'The application version.'."\n", - 'type' => 'string', - 'example' => '1.9.3', - ], - 'CanUpdate' => [ - 'description' => 'Indicates whether the instance can be upgraded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'VersionCode' => [ - 'description' => 'The version information.'."\n", - 'type' => 'string', - 'example' => 'EUREKA_1_9_3', - ], - 'InstanceCount' => [ - 'description' => 'The number of clusters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ClusterName' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'MseVersion' => [ - 'description' => 'The edition of the cluster.'."\n", - 'type' => 'string', - 'example' => 'mse_pro', - ], - 'Tags' => [ - 'description' => 'The tags that are attached to the instance.'."\n", - 'type' => 'object', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmv7jiavm4uxa', - ], - 'VpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-bp1hcg467ekqsv0zr****', - ], - 'MaintenancePeriod' => [ - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - ], - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], - ], + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The domain ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Name' => ['description' => 'The name.'."\n", 'type' => 'string', 'example' => 'CONTACTINFO'], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '253'], + 'Protocol' => ['description' => 'The protocol.'."\n", 'type' => 'string', 'example' => 'HTTP'], + 'MustHttps' => ['description' => 'Indicates whether HTTP probing is allowed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'CertIdentifier' => ['description' => 'The ID of the certificate.'."\n", 'type' => 'string', 'example' => '243'], + 'GmtCreate' => ['description' => 'The time when the domain name was added.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => 'The last modification time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], ], ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39016EAC-6EDB-52FE-AE20-4B013DF236FF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 2,\\n \\"Name\\": \\"CONTACTINFO\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 253,\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"243\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGatewayDomain', + 'summary' => 'Deletes a domain name that is associated with a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"IntranetDomain\\": \\"mse-7413****-eureka.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-7413****-p.eureka.mse.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-07-31 11:36:08\\",\\n \\"ChargeType\\": \\"按量付费\\",\\n \\"IntranetAddress\\": \\"192.168.XX.XX\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"InternetAddress\\": \\"47.98.XX.XX\\",\\n \\"ClusterAliasName\\": \\"mse-7413****\\",\\n \\"ClusterType\\": \\"Eureka\\",\\n \\"InitStatus\\": \\"RESTART_SUCCESS\\",\\n \\"AppVersion\\": \\"1.9.3\\",\\n \\"CanUpdate\\": true,\\n \\"VersionCode\\": \\"EUREKA_1_9_3\\",\\n \\"InstanceCount\\": 2,\\n \\"ClusterName\\": \\"mse-cn-st21ri2****\\",\\n \\"MseVersion\\": \\"mse_pro\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmv7jiavm4uxa\\",\\n \\"VpcId\\": \\"vpc-bp1hcg467ekqsv0zr****\\",\\n \\"MaintenancePeriod\\": {\\n \\"StartTime\\": \\"02:00\\",\\n \\"EndTime\\": \\"06:00\\"\\n },\\n \\"VersionLifecycle\\": \\"\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 202\\n 7\\n 69AD2AA7-DB47-449B-941B-B14409DF****\\n 请求处理成功\\n 10\\n 1\\n \\n 2021-08-01 00:00:00\\n mse-7413****-eureka.mse.aliyuncs.com\\n mse-7413****-p.eureka.mse.aliyuncs.com\\n 2020-07-31 11:36:08\\n 按量付费\\n 192.168.XX.XX\\n mse-cn-st21ri2****\\n 47.98.XX.XX\\n mse-7413****\\n Eureka\\n RESTART_SUCCESS\\n 1.9.3\\n \\n mse-100-000\\n true\\n","errorExample":""}]', - 'title' => 'ListClusters', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListClusterTypes' => [ - 'summary' => 'Queries the engine types that can be activated.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayFlowRule' => [ + 'summary' => 'Deletes a throttling rule for a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], ], [ - 'name' => 'ConnectType', + 'name' => 'RouteId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '网络连接类型', - 'description' => 'The network type. Valid values:'."\n" - ."\n" - .'* slb'."\n" - .'* eni'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'slb', - 'enum' => [ - 'eni', - 'slb', - ], - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11151', 'title' => ''], ], [ - 'name' => 'MseVersion', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" - ."\n" - .'* mse_pro: Professional Edition'."\n" - .'* mse_dev: Developer Edition'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => 'The ID of the throttling rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '821B5B05-8919-5FBB-BA75-417BFC093EB8', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ShowName' => [ - 'description' => 'The type of the MSE engine that can be activated.'."\n", - 'type' => 'string', - 'example' => 'Zookeeper', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', 'title' => ''], + 'Data' => ['description' => 'The response data.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"821B5B05-8919-5FBB-BA75-417BFC093EB8\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"ZooKeeper\\",\\n \\"ShowName\\": \\"Zookeeper\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListClusterTypes', ], - 'ListClusterVersions' => [ - 'summary' => 'Queries the information about supported instance versions.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayIsolationRule' => [ + 'summary' => 'Deletes a gateway concurrency rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ClusterType', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], ], [ - 'name' => 'MseVersion', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance edition. Valid values:'."\n" - ."\n" - .'* `mse_dev`: Developer Edition.'."\n" - .'* `mse_pro`: Professional Edition. This is the default value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => 'The ID of the route.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11151', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the concurrency rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7717BE5B-C958-5F87-BF49-464AA276EDD1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code of the instance type.'."\n", - 'type' => 'string', - 'example' => 'NACOS_2_0_0', - ], - 'ShowName' => [ - 'description' => 'The version of the instance.'."\n", - 'type' => 'string', - 'example' => '2.1.0', - ], - 'ClusterType' => [ - 'description' => 'The type of the instance.'."\n", - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', 'title' => ''], + 'Data' => ['description' => 'The response data.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayIsolationRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7717BE5B-C958-5F87-BF49-464AA276EDD1\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"NACOS_2_0_0\\",\\n \\"ShowName\\": \\"2.1.0\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListClusterVersions', ], - 'QueryClusterSpecification' => [ - 'summary' => 'Queries the information of supported instance specifications.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayRoute' => [ + 'summary' => 'Deletes a route from a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '25970', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], + ], 'parameters' => [ [ - 'name' => 'ConnectType', + 'name' => 'RouteId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '网络连接类型', - 'description' => 'The network type. Valid values:'."\n" - ."\n" - .'* slb'."\n" - .'* eni'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'slb', - 'pattern' => '', - 'enum' => [ - 'eni', - 'slb', - ], - ], + 'schema' => ['description' => 'The ID of the route.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '252', 'title' => ''], ], [ - 'name' => 'MseVersion', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" - ."\n" - .'* mse_pro: Professional Edition'."\n" - .'* mse_dev: Developer Edition'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'mse_pro', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The results that are returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'ClusterSpecificationName' => [ - 'description' => 'The engine specifications that can be used.'."\n", - 'type' => 'string', - 'example' => 'MSE_SC_1_2_200_c', - ], - 'MemoryCapacity' => [ - 'description' => 'The memory size in the specifications. Unit: GB.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'CpuCapacity' => [ - 'description' => 'The number of vCPUs in the specifications.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-5017305290e14cebbrvec4a5****', 'title' => ''], + 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'integer', 'format' => 'int64', 'example' => '125', 'title' => ''], + 'Predicates' => ['description' => 'The matching rules.', 'type' => 'string', 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', 'title' => ''], + 'DefaultServiceId' => ['description' => 'The default service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RouteOrder' => ['description' => 'The sequence number of the route.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The status of the route. Valid values:'."\n" + ."\n" + .'- 0: unpublished'."\n" + ."\n" + .'- 2: publishing'."\n" + ."\n" + .'- 3: published'."\n" + ."\n" + .'- 4: editing (updated but not published)'."\n" + ."\n" + .'- 5: unpublishing'."\n" + ."\n" + .'- 6: unavailable', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-30T06:41:52.000+0000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebbrvec4a5****\\",\\n \\"GatewayId\\": 125,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/metas\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":false}}\\",\\n \\"DefaultServiceId\\": 1,\\n \\"RouteOrder\\": 1,\\n \\"Status\\": 2,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2021-12-30T06:41:52.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGatewayRoute', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": [\\n {\\n \\"ClusterSpecificationName\\": \\"MSE_SC_1_2_200_c\\",\\n \\"MemoryCapacity\\": \\"2\\",\\n \\"CpuCapacity\\": \\"1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\nEE5C32A1-BC0E-4B79-817C-103E4EDF****\\n200\\n\\n 5000\\n 1\\n 1\\n 60\\n MSE_SC_1_2_200_c\\n 2\\n 3000\\n\\nmse-100-000\\n200\\ntrue\\n","errorExample":""}]', - 'title' => 'QueryClusterSpecification', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryClusterDiskSpecification' => [ - 'summary' => 'Queries disk specifications that are supported by an instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayService' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '76161', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '25194', + 'abilityTreeNodes' => ['FEATUREmse5GGXKF'], ], 'parameters' => [ [ - 'name' => 'ClusterType', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ZooKeeper', - ], + 'schema' => ['description' => 'The ID of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '190'], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E13A3A34-7201-50C4-B2D0-0D7DB891811E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'B3545F76-6ED1-586F-8DB9-ECE07985F381'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Step' => [ - 'description' => 'The step size of the disk capacity.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Max' => [ - 'description' => 'The maximum disk capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Min' => [ - 'description' => 'The minimum disk capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Id' => ['description' => 'The ID of the service.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '190'], + 'Name' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SourceType' => ['description' => 'The source type of the service.'."\n", 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + 'SourceId' => ['description' => 'The ID of the service source.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ServiceNameInRegistry' => ['description' => 'The name of the service registered with the service registry.'."\n", 'type' => 'string', 'example' => 'test'], + 'MetaInfo' => ['description' => 'The basic information about the service.'."\n", 'type' => 'string', 'example' => '{}'], + 'Ips' => [ + 'description' => 'IP'."\n", + 'type' => 'array', + 'items' => ['description' => 'IP'."\n", 'type' => 'string', 'example' => '127.0.1.12'], ], + 'GmtCreate' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2022-01-14 14:39:16'], + 'GmtModified' => ['description' => 'The last modification time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], ], ], ], @@ -14281,805 +9142,352 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E13A3A34-7201-50C4-B2D0-0D7DB891811E\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Step\\": 2,\\n \\"Max\\": 500,\\n \\"Min\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'QueryClusterDiskSpecification', - ], - 'ListInstanceCount' => [ - 'summary' => 'Displays the number of nodes that can be deployed for an instance.', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3545F76-6ED1-586F-8DB9-ECE07985F381\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 190,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\",\\n \\"SourceId\\": 1,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.1.12\\"\\n ],\\n \\"GmtCreate\\": \\"2022-01-14 14:39:16\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGatewayService', + 'summary' => 'Deletes a service from a gateway', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'DeleteGatewayServiceVersion' => [ + 'summary' => 'Deletes a service version from a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'abilityTreeCode' => '90283', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'ClusterType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instance. Valid values: ZooKeeper and Nacos-Ans.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Nacos-Ans', - ], - ], - [ - 'name' => 'MseVersion', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The edition type of the instance. Valid values:'."\n" - ."\n" - .'* `mse_dev`: Developer Edition'."\n" - .'* `mse_pro`: Professional Edition'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => 'The ID of the service.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '777', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region where the instance resides. Examples:'."\n" - ."\n" - .'* cn-hangzhou: China (Hangzhou)'."\n" - .'* cn-beijing: China (Beijing)'."\n" - .'* cn-shanghai: China (Shanghai)'."\n" - .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" - .'* cn-shenzhen: China (Shenzhen)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The version of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"name\\":\\"app\\",\\"labels\\":[{\\"key\\":\\"app\\",\\"value\\":\\"demo-server\\"}]}', 'title' => ''], ], [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-b6988bd16920479d9104e1729f97****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed. If the request failed, the ErrorCode parameter is returned. For more information, see the [Error codes](~~456441~~) section of this topic.'."\n", - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => '%s', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace `%s` in the `ErrMessage` parameter.'."\n" - ."\n" - .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The number of nodes that can be deployed for the instance of the current edition.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '29D52777-BE96-563E-BC6B-796ACE47A7A5'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D52777-BE96-563E-BC6B-796ACE47A7A5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'DeleteGatewayServiceVersion', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayServiceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"%s\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n 3\\n ]\\n}","type":"json"}]', - 'title' => 'ListInstanceCount', ], - 'QueryConfig' => [ - 'summary' => 'Queries configuration information of an instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewaySlb' => [ + 'summary' => 'Deletes the Server Load Balancer (SLB) instance that is associated with a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17081', - 'abilityTreeNodes' => [ - 'FEATUREmseY3D6DK', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '71802', + 'abilityTreeNodes' => ['FEATUREmseMNDRFM'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'ClusterId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The ID of the association record.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '395', 'title' => ''], ], [ - 'name' => 'ConfigType', + 'name' => 'DeleteSlb', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-st2212****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'title' => ''], ], [ - 'name' => 'NeedRunningConf', + 'name' => 'SlbId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether runtime configurations are required.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the SLB instance that needs to be deleted.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lb-uf6duug6s13x4abc8****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112EC53', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'MaxClientCnxns' => [ - 'description' => 'The number of connections between a client and a server. This parameter is valid for ZooKeeper instances.\\'."\n" - .'If this parameter is set to 0, no limits are imposed on the number of connections.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ConfigAuthSupported' => [ - 'description' => 'Indicates whether RAM authentication is supported by a configuration center of the instance. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: supported.'."\n" - .'* `false`: not supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'InitLimit' => [ - 'description' => 'The maximum connection duration of the instance. Unit: seconds. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'MCPEnabled' => [ - 'description' => 'Indicates whether Mesh Configuration Protocol (MCP) is enabled. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'OpenSuperAcl' => [ - 'description' => 'Indicates whether super permissions are enabled. This parameter is valid for ZooKeeper instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RestartFlag' => [ - 'description' => 'Indicates whether the instance was restarted and new configurations have taken effect. Valid values:'."\n" - ."\n" - .'* `true`: The restart was successful.'."\n" - .'* `false`: The restart failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'JvmFlagsCustom' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - 'AutopurgePurgeInterval' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - 'AutopurgeSnapRetainCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - 'SyncLimit' => [ - 'description' => 'The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ConfigAuthEnabled' => [ - 'description' => 'Indicates whether RAM authentication of a configuration center is enabled. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ClusterName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'MCPSupported' => [ - 'description' => 'Indicates whether MCP is supported. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: supported.'."\n" - .'* `false`: not supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'JuteMaxbuffer' => [ - 'description' => 'The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TickTime' => [ - 'description' => 'The time unit of the engine. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '2000', - ], - 'PassWord' => [ - 'description' => 'The password that corresponds to the username. This parameter is valid only if OpenSuperAcl is set to true.'."\n", - 'type' => 'string', - 'example' => 'password', - ], - 'UserName' => [ - 'description' => 'The username of the user. This parameter is valid only if OpenSuperAcl is set to true.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'ConfigSecretSupported' => [ - 'description' => 'Indicates whether configuration encryption of a configuration center is supported by the instance. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: supported.'."\n" - .'* `false`: not supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ConfigSecretEnabled' => [ - 'description' => 'Indicates whether configuration encryption of a configuration center is enabled by the instance. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NamingAuthEnabled' => [ - 'description' => 'Indicates whether RAM authentication of a registry is enabled. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: enabled.'."\n" - .'* `false`: disabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'NamingAuthSupported' => [ - 'description' => 'Indicates whether RAM authentication of services is supported by the instance. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: supported.'."\n" - .'* `false`: not supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NamingCreateServiceSupported' => [ - 'description' => 'Indicates whether service creation is supported for the instance. This parameter is valid for Nacos instances. Valid values:'."\n" - ."\n" - .'* `true`: supported.'."\n" - .'* `false`: not supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MinSessionTimeout' => [ - 'title' => '最小超时时间', - 'description' => 'The minimum timeout period. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'MaxSessionTimeout' => [ - 'title' => '最大超时时间', - 'description' => 'The maximum timeout period. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'SnapshotCount' => [ - 'description' => 'The frequency for generating snapshots. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'string', - 'example' => '100000', - ], - 'ConfigContentLimit' => [ - 'description' => 'The maximum size of contents in a configuration. Unit: KB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'NacosRunningEnv' => [ - 'description' => 'The runtime configuration of the Nacos instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'emptyProtect' => [ - 'description' => 'Indicates whether empty list protection is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'grayAuth' => [ - 'type' => 'string', - ], - 'fenceEnabled' => [ - 'type' => 'boolean', - ], - 'fencePolicy' => [ - 'type' => 'object', - 'properties' => [ - 'interceptPolicy' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - 'enabledModules' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'serviceName' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'ExtendedTypesEnable' => [ - 'description' => 'Indicates whether the time to live (TTL) configuration is enabled. This parameter is valid for ZooKeeper instances.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EurekaSupported' => [ - 'description' => 'Indicates whether access port 8761 was enabled for Eureka. If this port is disabled, applications cannot use the Eureka protocol for service registration and discovery.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TLSEnabled' => [ - 'description' => 'MSE Nacos supports TLS transmission link encryption since version 2.1.2.1. Nacos clients must be upgraded to version 2.2.1 or later. After TLS is enabled, the system performance will decrease by about 10%. You must evaluate the system capacity. For more information about the relevant operations, see Nacos TLS transmission encryption.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ConsoleUIEnabled' => [ - 'description' => 'Indicates whether the Nacos open source console is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Enable4lw' => [ - 'type' => 'boolean', - ], - 'AuthEnabled' => [ - 'title' => 'ZooKeeper sasl 强制身份认证开关', - 'description' => 'Indicates whether Simple Authentication and Security Layer (SASL) forced identity authentication is enabled for the ZooKeeper instance.'."\n", - 'type' => 'boolean', - ], - 'PrometheusSdProtocolEnabled' => [ - 'type' => 'string', - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The deletion result.'."\n", 'type' => 'string', 'example' => '28', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9297B27D-D932-5E9F-93B9-99D6C5F3A879\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": \\"28\\"\\n}","type":"json"}]', + 'title' => 'DeleteGatewaySlb', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112EC53\\",\\n \\"Data\\": {\\n \\"MaxClientCnxns\\": \\"0\\",\\n \\"ConfigAuthSupported\\": true,\\n \\"InitLimit\\": \\"100\\",\\n \\"MCPEnabled\\": true,\\n \\"OpenSuperAcl\\": true,\\n \\"RestartFlag\\": true,\\n \\"JvmFlagsCustom\\": \\"none\\",\\n \\"AutopurgePurgeInterval\\": \\"none\\",\\n \\"AutopurgeSnapRetainCount\\": \\"none\\",\\n \\"SyncLimit\\": \\"10\\",\\n \\"ConfigAuthEnabled\\": true,\\n \\"ClusterName\\": \\"name\\",\\n \\"MCPSupported\\": true,\\n \\"JuteMaxbuffer\\": \\"1\\",\\n \\"TickTime\\": \\"2000\\",\\n \\"PassWord\\": \\"password\\",\\n \\"UserName\\": \\"name\\",\\n \\"ConfigSecretSupported\\": true,\\n \\"ConfigSecretEnabled\\": true,\\n \\"NamingAuthEnabled\\": false,\\n \\"NamingAuthSupported\\": true,\\n \\"NamingCreateServiceSupported\\": true,\\n \\"MinSessionTimeout\\": \\"-1\\",\\n \\"MaxSessionTimeout\\": \\"-1\\",\\n \\"SnapshotCount\\": \\"100000\\",\\n \\"ConfigContentLimit\\": 100,\\n \\"NacosRunningEnv\\": {\\n \\"emptyProtect\\": true,\\n \\"grayAuth\\": \\"\\",\\n \\"fenceEnabled\\": true,\\n \\"fencePolicy\\": {\\n \\"interceptPolicy\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"enabledModules\\": [\\n \\"\\"\\n ],\\n \\"serviceName\\": \\"\\"\\n }\\n },\\n \\"ExtendedTypesEnable\\": true,\\n \\"EurekaSupported\\": true,\\n \\"TLSEnabled\\": true,\\n \\"ConsoleUIEnabled\\": true,\\n \\"Enable4lw\\": true,\\n \\"AuthEnabled\\": true,\\n \\"PrometheusSdProtocolEnabled\\": \\"\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\n8BD1E58D-0755-42AC-A599-E6B55112EC53\\n\\n true\\n 0\\n name\\n true\\n 2000\\n none\\n password\\n 100\\n true\\n none\\n true\\n none\\n 1\\n true\\n name\\n true\\n 10\\n\\nmse-100-100\\ntrue\\n","errorExample":""}]', - 'title' => 'QueryConfig', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetImage' => [ - 'summary' => 'Queries the maximum version number to which the current version can be upgraded.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteIsolationRules' => [ + 'summary' => 'Deletes fencing rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '43433', - 'abilityTreeNodes' => [ - 'FEATUREmseLINUSD', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '163574', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'VersionCode', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '集群版本', - 'description' => 'The version number of the current instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ZooKeeper_3_5_5', - ], + 'schema' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Ids', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The list of rule IDs to be deleted.', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], 'required' => false, - 'example' => 'zh', + 'maxItems' => 100, + 'example' => '', ], ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language in which the response is displayed. Valid values: zh (default): Chinese; en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'CurrentVersionFullShowName' => [ - 'title' => '当前集群镜像版本的4位全名', - 'description' => 'The full version number of the current instance image. The parameter is in the X.X.X.X format.'."\n", - 'type' => 'string', - 'example' => '3.5.5.0', - ], - 'MaxVersionCode' => [ - 'title' => '可升级的增量版本Code', - 'description' => 'The code of the maximum version to which the current version can be upgraded.'."\n", - 'type' => 'string', - 'example' => 'ZooKeeper_3_6_3', - ], - 'MaxVersionFullShowName' => [ - 'title' => '可升级的增量版本全名', - 'description' => 'The full number of the maximum version to which the current version can be upgraded.'."\n", - 'type' => 'string', - 'example' => '3.6.3.0', - ], - 'MaxVersionChangelogUrl' => [ - 'title' => '可升级的最大版本变更日志url', - 'description' => 'The URL of the changelog for the maximum version to which the current version can be upgraded.'."\n", - 'type' => 'string', - 'example' => 'https://xxxxx', - ], - ], + 'title' => '', + 'description' => 'The list of rule IDs that have been deleted.', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteIsolationRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25EA0A83-9007-4E87-808C-637BE1A****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"CurrentVersionFullShowName\\": \\"3.5.5.0\\",\\n \\"MaxVersionCode\\": \\"ZooKeeper_3_6_3\\",\\n \\"MaxVersionFullShowName\\": \\"3.6.3.0\\",\\n \\"MaxVersionChangelogUrl\\": \\"https://xxxxx\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetImage', ], - 'UpdateImage' => [ - 'summary' => 'Updates the version number of the destination cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteMigrationTask' => [ + 'summary' => 'Deletes a migration task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -15087,265 +9495,226 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '43431', - 'abilityTreeNodes' => [ - 'FEATUREmseLINUSD', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '目标集群的id', - 'description' => 'The ID of the destination cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mse-8e8e9060', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'VersionCode', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '想修改的镜像版本code', - 'description' => 'The destination version number.'."\n" - ."\n" - .'> You must call the GetImage operation to obtain the maximum destination version number that corresponds to MaxVersionCode.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ZooKeeper_3_5_5', - ], + 'schema' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3855D475-2B66-5CFF-9A51-3D698E52C472', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The deletion result.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteMigrationTask', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3855D475-2B66-5CFF-9A51-3D698E52C472\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateImage', ], - 'GetMseFeatureSwitch' => [ - 'summary' => 'Queries the information about the MSE feature switch.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteNacosConfig' => [ + 'summary' => 'Delete specified Nacos configuration', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'abilityTreeCode' => '17011', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], ], 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-tl32epfyu18', 'title' => ''], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => 'Configuration ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-ds.yml', 'title' => ''], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => 'Group type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HALVIE_MICRO_GROUP', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'Namespace ID. Default is public.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0e9d849b-****-8435da6c21ad', 'title' => ''], + ], + [ + 'name' => 'Beta', + 'in' => 'query', + 'schema' => ['description' => 'Whether it is a Beta release. Default is false.'."\n" + ."\n" + .'- `true`: Yes'."\n" + .'- `false`: No', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6B4653A3-8D9C-5FDC-BB0C-936D40E9794B', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'example' => '{\'nacos_config_encrypt\': False}', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '202', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84', 'title' => ''], + 'Message' => ['description' => 'Message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'Return code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Request result, with the following values: - `true`: The request was successful. - `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Nacos Configuration', + 'description' => '> The current OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"6B4653A3-8D9C-5FDC-BB0C-936D40E9794B\\",\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetMseFeatureSwitch', + 'translator' => 'machine', ], - 'QueryBusinessLocations' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'common', - ], + 'DeleteNacosConfigs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'abilityTreeCode' => '17012', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], ], 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-i7m2e32pd0n'], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of configurations.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20024,20025,20026,20027,20034,20104,20394'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1ef93a21-3487-4367-a859-857d8****'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -15354,299 +9723,184 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The parameter is invalid.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Ordering' => [ - 'description' => 'The ordering information.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'region', - ], - 'DistrictEnName' => [ - 'description' => 'The English name of the district.'."\n", - 'type' => 'string', - 'example' => 'Asia Pacific', - ], - 'ShowName' => [ - 'description' => 'The display name.'."\n", - 'type' => 'string', - 'example' => 'China (Shanghai)'."\n", - ], - 'DistrictCnName' => [ - 'description' => 'The Chinese name of the district.'."\n", - 'type' => 'string', - 'example' => 'Asia Pacific'."\n", - ], - 'EnName' => [ - 'description' => 'The English name of the region.'."\n", - 'type' => 'string', - 'example' => 'China (Shanghai)', - ], - 'DistrictId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'asia-pacific', - ], - 'DistrictShowName' => [ - 'description' => 'The display name of the district.'."\n", - 'type' => 'string', - 'example' => 'Asia Pacific'."\n", - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'China (Shanghai)'."\n", - ], - 'EnDescription' => [ - 'description' => 'The complete description of the region.'."\n", - 'type' => 'string', - 'example' => 'China East 2 (Shanghai)', - ], - 'CnName' => [ - 'description' => 'The Chinese name of the region.'."\n", - 'type' => 'string', - 'example' => 'China (Shanghai)'."\n", - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'DistrictOrdering' => [ - 'description' => 'The ordering information of the district.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '101', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '73EB5563-CBB3-5F48-999D-512F4EFB7377'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"RequestId\\": \\"73EB5563-CBB3-5F48-999D-512F4EFB7377\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteNacosConfigs', + 'summary' => 'Deletes multiple Nacos configurations at a time.', + 'description' => '> The current API operation is not provided in Nacos SDK. For more information about the Nacos-SDK API, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Data\\": [\\n {\\n \\"Ordering\\": 6,\\n \\"Type\\": \\"region\\",\\n \\"DistrictEnName\\": \\"Asia Pacific\\",\\n \\"ShowName\\": \\"华东2（上海）\\",\\n \\"DistrictCnName\\": \\"亚太\\",\\n \\"EnName\\": \\"China (Shanghai)\\",\\n \\"DistrictId\\": \\"asia-pacific\\",\\n \\"DistrictShowName\\": \\"亚太\\",\\n \\"Description\\": \\"华东 2\\",\\n \\"EnDescription\\": \\"China East 2 (Shanghai)\\",\\n \\"CnName\\": \\"华东2（上海）\\",\\n \\"Name\\": \\"cn-shanghai\\",\\n \\"DistrictOrdering\\": 101\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n3369AD10-F1A6-4E6F-B99E-20F51826****\\n参数不合法\\n\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n 111\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'QueryBusinessLocations', - 'summary' => 'Queries information about regions.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListClusterConnectionTypes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteNacosInstance' => [ + 'summary' => 'Deletes a persistent application instance from a Microservices Engine (MSE) Nacos instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '76158', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '121118', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Nacos instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mse-cn-st21v5****', 'title' => ''], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hello_service', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['description' => 'The alias of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', 'default' => 'DEFAULT', 'title' => ''], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['description' => 'The IP address of the Nacos instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '10.237.1.32', 'title' => ''], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'The port of the Nacos instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8080', 'title' => ''], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the node is an ephemeral node. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8625467C-27DD-5711-878E-6857E3074937', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'ShowName' => [ - 'description' => 'The connection type.'."\n", - 'type' => 'string', - 'example' => 'slb', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. The value 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'DeleteNacosInstance', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8625467C-27DD-5711-878E-6857E3074937\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"ShowName\\": \\"slb\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListClusterConnectionTypes', - 'summary' => 'Queries available cluster connection types.', ], - 'QuerySlbSpec' => [ - 'summary' => 'Queries the type of a Server Load Balancer (SLB) instance.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'DeleteNacosService' => [ + 'summary' => 'Deletes a Nacos service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -15655,157 +9909,99 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'abilityTreeCode' => '18547', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456', 'title' => ''], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0****', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The string object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the SLB instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the returned data.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Spec' => [ - 'description' => 'The specification of the instance.'."\n", - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'Name' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'Standard I'."\n", - ], - 'MaxConnection' => [ - 'description' => 'The maximum number of connections.'."\n", - 'type' => 'string', - 'example' => '50,000', - ], - 'NewConnectionPerSecond' => [ - 'description' => 'The number of connections per second.'."\n", - 'type' => 'string', - 'example' => '50,000', - ], - 'Qps' => [ - 'description' => 'The number of queries per second (QPS).'."\n", - 'type' => 'string', - 'example' => '50,000', - ], - ], - ], - ], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '', 'description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '', 'description' => 'The deletion result.'."\n", 'type' => 'string', 'example' => 'ok'], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteNacosService', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 2,\\n \\"Spec\\": \\"slb.s2.small\\",\\n \\"Name\\": \\"标准型I\\",\\n \\"MaxConnection\\": \\"50,000\\",\\n \\"NewConnectionPerSecond\\": \\"50,000\\",\\n \\"Qps\\": \\"50,000\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'QuerySlbSpec', ], - 'UpdateClusterSpec' => [ - 'summary' => 'Updates the number or specifications of nodes in a pay-as-you-go Microservices Engine (MSE) instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteNamespace' => [ + 'summary' => 'Deletes an MSE namespace.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -15813,928 +10009,584 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '网关名称', - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The region of the operation.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '节点规格', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'The name of the MSE namespace to be deleted.', 'type' => 'string', 'example' => 'prod', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'InstanceCount', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['description' => 'The language in which the response is displayed. Valid values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '节点数量', - 'description' => 'The number of destination nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Request information for troubleshooting.', 'type' => 'string', 'default' => '请求处理成功', 'title' => '', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'abcde-efg', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'NO_PERMISSION', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'ClusterSpecification', - 'in' => 'query', - 'schema' => [ - 'description' => 'The destination engine specifications.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MSE_SC_4_8_200_c' => 'MSE_SC_4_8_200_c', - 'MSE_SC_16_32_200_c' => 'MSE_SC_16_32_200_c', - 'MSE_SC_2_4_200_c' => 'MSE_SC_2_4_200_c', - 'MSE_SC_8_16_200_c' => 'MSE_SC_8_16_200_c', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"abcde-efg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\"\\n}","type":"json"}]', + 'title' => 'DeleteNamespace', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'MSE_SC_2_4_200_c', ], ], + ], + 'translator' => 'manual', + ], + 'DeletePluginConfig' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'MseVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The MSE version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro'."\n", - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '217729', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], + ], + 'parameters' => [ [ - 'name' => 'PubNetworkFlow', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '公网带宽', - 'type' => 'integer', - 'format' => 'int32', - 'minimum' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'AutoPay', + 'name' => 'PluginConfigId', 'in' => 'query', - 'schema' => [ - 'title' => '是否下单之后自动支付，如果此值为false，此接口将会返回订单支付url，可手动确认支付', - 'type' => 'boolean', - 'default' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The plug-in configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '200'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - 'title' => '如果AutoPay设置为false，则此值为订单支付的URL', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed. Take note of the following rules:'."\n" - ."\n" - .'* The **ErrorCode** parameter is not returned if the request succeeds.'."\n" - .'* The **ErrorCode** parameter is returned if the request fails. For more information, see the **Error codes** section in this topic.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\"\\n}","type":"json"}]', + 'title' => 'DeletePluginConfig', + 'summary' => 'Deletes a plug-in configuration.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeletePluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"null\\",\\n \\"ErrorCode\\": \\"mse-100-000\\"\\n}","type":"json"}]', - 'title' => 'UpdateClusterSpec', - 'description' => 'You can call this operation to update the number or specifications of nodes in a pay-as-you-go MSE instance. You are charged when you add nodes or upgrade node specifications. For more information, see \\[Pricing] (`~~1806469~~`).'."\n", ], - 'RestartCluster' => [ - 'summary' => 'Restarts a registry.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteSecurityGroupRule' => [ + 'summary' => 'Deletes a security group rule from a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17093', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The ID of the security group rule.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '93', 'title' => ''], ], [ - 'name' => 'PodNameList', + 'name' => 'CascadingDelete', 'in' => 'query', - 'schema' => [ - 'description' => 'The names of pods. You can specify the names of multiple pods at a time. Separate multiple pod names with commas (,). Example: mse-a8aba010-1629719288255-reg-center-0-1,mse-a8aba010-1629719288255-reg-center-0-2.'."\n" - ."\n" - .'The specified pods must belong to the current cluster and be associated with the specified instance. Otherwise, a restart exception occurs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-a8aba010-1629719288255-reg-center-0-1', - ], + 'schema' => ['description' => 'Specifies whether to perform a cascading delete.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '43E50CB7-258E-5AFF-9B93-ECC19928C699'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-uf6hgwe067prhg68agfa', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****', 'title' => ''], + 'PortRange' => ['description' => 'The transport-layer port range. Valid values:'."\n" + ."\n" + .'- For TCP or UDP, the port range is 1 to 65535. Use a forward slash (/) to separate the start port from the end port. For example: `1/200`.'."\n" + ."\n" + .'- For ICMP, the value is `-1/-1`.'."\n" + ."\n" + .'- For GRE, the value is `-1/-1`.'."\n" + ."\n" + .'- For all protocols, the value is `-1/-1`.', 'type' => 'string', 'example' => '8443/8443', 'title' => ''], + 'IpProtocol' => ['description' => 'The transport-layer protocol. The value is not case-sensitive. Valid values:'."\n" + ."\n" + .'- icmp'."\n" + ."\n" + .'- gre'."\n" + ."\n" + .'- tcp'."\n" + ."\n" + .'- udp'."\n" + ."\n" + .'- all: The rule applies to all protocols.', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '103', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the rule was created.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the rule was last modified.', 'type' => 'string', 'example' => '2022-01-11T14:12:55.000+0000', 'title' => ''], + 'Description' => ['description' => 'The description of the rule.', 'type' => 'string', 'example' => 'auto-description1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43E50CB7-258E-5AFF-9B93-ECC19928C699\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 2,\\n \\"SecurityGroupId\\": \\"sg-uf6hgwe067prhg68agfa\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"PortRange\\": \\"8443/8443\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"GatewayId\\": 103,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-11T14:12:55.000+0000\\",\\n \\"Description\\": \\"auto-description1\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteSecurityGroupRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n请求成功\\n5B170A0D-2C5D-4CF8-B808-03966B86****\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'RestartCluster', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'translator' => 'machine', ], - 'RetryCluster' => [ - 'summary' => 'Retries a cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteServiceSource' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17094', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '24910', + 'abilityTreeNodes' => ['FEATUREmseQRG9VI'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'SourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The ID of the data source.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '17'], ], [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be850****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2CEF593F-D60C-5449-9E98-15CA6ECD9189'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CEF593F-D60C-5449-9E98-15CA6ECD9189\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteServiceSource', + 'summary' => 'Deletes a gateway service source.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RetryCluster', ], - 'UpgradeCluster' => [ - 'summary' => 'Upgrades the version of a cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteSwimmingLane' => [ + 'summary' => 'Deletes a lane.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'LaneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-nif1w51wi0c', - ], + 'schema' => ['description' => 'The ID of the lane.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '229', 'title' => ''], ], [ - 'name' => 'UpgradeVersion', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The destination version.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1.2.1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'HttpCode' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8D855418-177B-5FF8-A021-75B930AD890A', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"The request is processed successfully.\\"\\n}","type":"json"}]', + 'title' => 'DeleteSwimmingLane', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"8D855418-177B-5FF8-A021-75B930AD890A\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpgradeCluster', ], - 'CreateEngineNamespace' => [ - 'summary' => 'Creates a namespace in a Nacos instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteSwimmingLaneGroup' => [ + 'summary' => 'Deletes a lane group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '17003', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-98s****', - ], + 'schema' => ['description' => 'The ID of the lane group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '145', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dev', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'Desc', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Development environment'."\n", - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-cn-st21ri2****', - ], - ], - [ - 'name' => 'ServiceCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of services that can run in the namespace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom ID of the namespace. If you do not specify this parameter, the automatically generated Universally Unique Identifier (UUID) is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', - ], + 'schema' => ['description' => 'The name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example-app', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', - ], - 'ClusterId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-892k****', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the namespace. Valid values:'."\n" - ."\n" - .'* `0`: global configuration'."\n" - .'* `1`: default namespace'."\n" - .'* `2`: custom namespace'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NamespaceShowName' => [ - 'description' => 'The display name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'dev', - ], - 'Quota' => [ - 'description' => 'The quota of configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespace' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', - ], - 'NamespaceDesc' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mytest', - ], - 'ConfigCount' => [ - 'description' => 'The number of configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceCount' => [ - 'description' => 'The number of active services.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Data' => ['description' => 'The details of the data.'."\n", 'type' => 'any', 'example' => '{}', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => 'DeleteSwimmingLaneGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"F6092602-C357-4750-89D9-E572FBEA****\\",\\n \\"ClusterId\\": \\"mse-892k****\\",\\n \\"Data\\": {\\n \\"Type\\": 1,\\n \\"NamespaceShowName\\": \\"dev\\",\\n \\"Quota\\": 1,\\n \\"Namespace\\": \\"f4fa5b81-2f26-4900-833a-7516b315ebb2\\",\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"ConfigCount\\": 1,\\n \\"ServiceCount\\": 3\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nF6092602-C357-4750-89D9-E572FBEA****\\n请求处理成功\\nmse-892k****\\n\\n 1\\n 1\\n 1\\n public\\n 3\\n mytest\\n DEFAULT\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'CreateEngineNamespace', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteEngineNamespace' => [ - 'summary' => 'Deletes a namespace from a Nacos instance.', - 'methods' => [ - 'post', - 'get', - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteWebFlowRules' => [ + 'summary' => 'Deletes hot spot parameter protection rules for HTTP requests.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '17010', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], + 'abilityTreeCode' => '164288', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '678ca857-****-b1bf-d0a98c5ca84b', - ], + 'schema' => ['description' => 'MSE namespace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-7pp2d1****', - ], + 'schema' => ['description' => 'List of rule IDs to be deleted.', 'type' => 'string', 'required' => true, 'example' => '[1, 2, 3]', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-0c738****', - ], + 'schema' => ['description' => 'Application name.', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Language of the response. Valid values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -16742,84 +10594,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '354FF159-E9FB-5FBA-BDD5-E99EE440A88D', 'title' => ''], + 'Success' => ['description' => 'Request result, with the following values:'."\n" + ."\n" + .'- `true`: The request is successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'Return data.', + 'type' => 'array', + 'items' => ['description' => 'IDs of the rules that were successfully deleted.', 'type' => 'integer', 'format' => 'int64', 'example' => '[1, 2, 3]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"354FF159-E9FB-5FBA-BDD5-E99EE440A88D\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteWebFlowRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteEngineNamespace', ], - 'UpdateEngineNamespace' => [ - 'summary' => 'Updates a namespace for the Nacos engine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteZnode' => [ + 'summary' => 'Deletes a ZooKeeper node.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -16827,783 +10661,436 @@ ], 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17100', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '17014', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'name', - ], - ], - [ - 'name' => 'Desc', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'public', - ], - ], - [ - 'name' => 'ServiceCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of active services.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'Id', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the namespace. Valid values:'."\n" - ."\n" - .'* `0`: global configuration'."\n" - .'* `1`: default namespace'."\n" - .'* `2`: custom namespace'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NamespaceShowName' => [ - 'description' => 'The display name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mytestshowname', - ], - 'Quota' => [ - 'description' => 'The quota of configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'NamespaceDesc' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mytest', - ], - 'ConfigCount' => [ - 'description' => 'The quota value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'Path' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'example' => '/', 'title' => ''], + 'Dir' => ['description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper the operation times out, it may be because the current Znode data is too large, there are too many child nodes, the server takes too long to process the request, or the cluster is currently selecting a host and cannot process the request.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => 'The currently operating node does not exist and may have been deleted.'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": {\\n \\"Type\\": 1,\\n \\"NamespaceShowName\\": \\"mytestshowname\\",\\n \\"Quota\\": 1,\\n \\"Namespace\\": \\"public\\",\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"ConfigCount\\": 1\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n4E9FDCFE-0738-493B-B801-82BDFBCB****\\n请求处理成功\\n\\n 1\\n 1\\n 1\\n mytestshowname\\n mytest\\n public\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'UpdateEngineNamespace', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteZnode', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetEngineNamepace' => [ - 'summary' => 'Queries the namespaces of a Nacos instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'EnableHttp2' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17029', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '142072', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The destination ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0e958d79-****-b282-b702d66362b5', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse.cn-hangzhou.aliyuncs.com', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****'], ], [ - 'name' => 'ClusterId', + 'name' => 'EnableHttp2', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-98s****', - ], + 'schema' => ['description' => 'Specifies whether to enable HTTP/2 for negotiation between the server and client. This parameter applies to requests. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'Type' => [ - 'description' => 'The type of the namespace. Valid values:'."\n" - ."\n" - .'* 0: global configuration'."\n" - .'* 1: default namespace'."\n" - .'* 2: custom namespace'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Quota' => [ - 'description' => 'The quota of configurations.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FA8F966F-420C-52F5-B49E-6ED7CCE02697', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ConfigCount' => [ - 'description' => 'The number of configurations.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'NamespaceShowName' => [ - 'description' => 'The display name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NamespaceDesc' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mytest', - ], - 'Namespace' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'OK'], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> The request parameter **DtsJobId** is invalid if **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => 'Indicates whether HTTP/2 is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'EnableHttp2', + 'summary' => 'Enables HTTP/2 for negotiation between the server and client. The modification takes effect in one to two minutes.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:EnableHttp2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Type\\": \\"1\\",\\n \\"Quota\\": \\"200\\",\\n \\"RequestId\\": \\"FA8F966F-420C-52F5-B49E-6ED7CCE02697\\",\\n \\"Message\\": \\"success\\",\\n \\"ConfigCount\\": \\"1\\",\\n \\"NamespaceShowName\\": \\"public\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"Namespace\\": \\"public\\"\\n}","type":"json"}]', - 'title' => 'GetEngineNamepace', ], - 'ListEngineNamespaces' => [ - 'summary' => 'Queries the namespaces of a Nacos instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'EnableProxyProtocol' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '17066', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****'], + ], + [ + 'name' => 'EnableProxyProtocol', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '062D13C5-DEA3-4921-8918-C49A0F1B****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the namespace. Valid values:'."\n" - ."\n" - .'* `0`: global configuration'."\n" - .'* `1`: default namespace'."\n" - .'* `2`: custom namespace'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NamespaceShowName' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'Quota' => [ - 'description' => 'The quota.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'NamespaceDesc' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mytest', - ], - 'ConfigCount' => [ - 'description' => 'The quota value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceCount' => [ - 'description' => 'The number of active services.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'SourceType' => [ - 'description' => 'The source from which the namespace was created.'."\n", - 'type' => 'string', - 'example' => 'mse', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK'], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> For example, if the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the **DtsJobId** parameter in the request is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'OperationNotSupport', - 'errorMessage' => 'The current cluster does not support this operation, %s.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'EnableProxyProtocol', + 'summary' => 'Enables the proxy protocol. When an NLB instance is used as an ingress, you cannot obtain the real IP address of the client if you do not enable the proxy protocol. After you enable the proxy protocol, non-proxy requests are not adversely affected.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:EnableProxyProtocol', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"062D13C5-DEA3-4921-8918-C49A0F1B****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Type\\": 0,\\n \\"NamespaceShowName\\": \\"public\\",\\n \\"Quota\\": 200,\\n \\"Namespace\\": \\"DEFAULT\\",\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"ConfigCount\\": 1,\\n \\"ServiceCount\\": \\"3\\",\\n \\"SourceType\\": \\"mse\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n202\\n7\\n10\\n请求处理成功\\n062D13C5-DEA3-4921-8918-C49A0F1B****\\n1\\n\\n 0\\n 200\\n 1\\n public\\n 3\\n mytest\\n DEFAULT\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListEngineNamespaces', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ImportZookeeperData' => [ - 'summary' => 'Initiates a task to import data from a destination URL to a Microservices Engine (MSE) ZooKeeper instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ExportNacosConfig' => [ + 'summary' => 'Exports specified Nacos configurations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '146919', - 'abilityTreeNodes' => [ - 'FEATUREmseBQYNCQ', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76155', + 'abilityTreeNodes' => ['FEATUREmse8153EN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-2r42ddc****', 'title' => ''], ], [ - 'name' => 'FileUrl', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the source data.'."\n" - ."\n" - .'> You must set this parameter to the URL that is generated by calling the GetZookeeperDataImportUrl operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ae77c258-4d4f-478f-baaa-084aee0****', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the file that you want to import.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'snapshot.5', - ], + 'schema' => ['description' => 'The ID of the primary key of a configuration item.'."\n" + ."\n" + .'> - Multiple export methods are supported. You must specify this parameter if you want to export multiple configurations. - You can obtain the value of this parameter by calling the ListNacosConfigs operation. - If you specify this parameter, multiple configurations are exported. The DataId and Group parameters are invalid.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '1709,1710', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the data that you want to export.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Multiple export methods are supported.'."\n" + ."\n" + .'* If you want to export a single configuration, you must leave the Ids parameter empty and specify the DataID and Group parameters.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'demo-develop', 'title' => ''], ], [ - 'name' => 'RequestPars', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'COMMON_GROUP', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application tag.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'gateway-openapi', 'title' => ''], + ], + [ + 'name' => 'DataIds', + 'in' => 'query', + 'schema' => ['description' => 'The configuration group name and the ID of the configuration that you want to export. Separate multiple configurations with comma (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDataId1+testGroup1,testDataId2+testGroup', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '202', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '92245803-49B7-54CF-8D49-01A34A0E1CD6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace **%s** in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", - 'type' => 'any', - 'example' => 'null', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The URL that is used to download the exported configurations.'."\n", 'type' => 'string', 'example' => 'http://xxxxxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"92245803-49B7-54CF-8D49-01A34A0E1CD6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'ExportNacosConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ExportNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#AccountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - 'title' => 'ImportZookeeperData', - 'description' => '**Danger** This operation clears existing data. Exercise caution when you call this API operation.', ], - 'GetZookeeperDataImportUrl' => [ - 'summary' => 'mse-200-105', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'wss', - ], - 'tags' => [ - 'cluster', - ], + 'ExportZookeeperData' => [ + 'summary' => 'Initiates a task to export ZooKeeper data.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -17613,169 +11100,132 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '146920', - 'abilityTreeNodes' => [ - 'FEATUREmseBQYNCQ', - ], + 'abilityTreeCode' => '161337', + 'abilityTreeNodes' => ['FEATUREmseBQYNCQ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-zvp2xzzkk06', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****', 'title' => ''], ], [ - 'name' => 'ContentType', + 'name' => 'ExportType', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zip', - ], + 'schema' => ['description' => 'The type of the object that is exported. Valid values:'."\n" + ."\n" + .'* transactionLog: transaction logs'."\n" + .'* snapshot: snapshots'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'snapshot', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'RestResult'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The ID of the request.'."\n", + 'title' => 'BaseResult', + 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'E4E2058F-C524-5C29-9BC7-5874EA8D7CE2', - ], - 'Success' => [ - 'description' => 'The status code. A value of 200 is returned if the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The request was successfully processed.'."\n", - 'type' => 'string', - 'example' => 'The dynamic part in the error message.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The URL that is used to upload the configuration file.'."\n", + 'description' => 'The details of the data.'."\n", 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'The maximum size of a file that can be uploaded each time. Unit: MB.'."\n", - 'type' => 'string', - 'example' => 'http://xxxxxxxxx', - ], - 'MaxSize' => [ - 'description' => 'code', - 'type' => 'string', - 'example' => '250000', - ], + 'InstanceId' => ['description' => 'The ID of the instance'."\n", 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'ExportType' => ['description' => 'The type of the object that is exported. Valid values:'."\n" + ."\n" + .'* transactionLog: transaction logs'."\n" + .'* snapshot: snapshots'."\n", 'type' => 'string', 'example' => 'snapshot', 'title' => ''], + 'ContentMap' => ['description' => 'The content of a task.'."\n", 'type' => 'object', 'title' => '', 'example' => ''], + 'Extend' => ['description' => 'The extended information.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Status' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* CREATE: The object is being created.'."\n" + .'* RUNNING: The task is running.'."\n" + .'* FINISH: The task is completed.'."\n" + .'* FAILED: The task fails.'."\n" + .'* EXPIRE: The task has expired.'."\n", 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'KubeoneTaskIds' => ['description' => 'The ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"RequestId\\": \\"25EA0A83-9007-4E87-808C-637BE1A****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ExportType\\": \\"snapshot\\",\\n \\"ContentMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Extend\\": \\"{}\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"KubeoneTaskIds\\": \\"10\\",\\n \\"Id\\": 1,\\n \\"CreateTime\\": 1631001140913,\\n \\"UpdateTime\\": 1632979237663\\n }\\n}","type":"json"}]', + 'title' => 'ExportZookeeperData', + 'description' => 'Only one task can run at a time.'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ExportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4E2058F-C524-5C29-9BC7-5874EA8D7CE2\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"You are not authorized to perform this operation.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\",\\n \\"MaxSize\\": \\"250000\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetZookeeperDataImportUrl', ], - 'ExportZookeeperData' => [ - 'summary' => 'Initiates a task to export ZooKeeper data.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'FetchLosslessRuleList' => [ + 'summary' => 'Retrieves the rules for graceful start and shutdown.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -17783,232 +11233,149 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '161337', - 'abilityTreeNodes' => [ - 'FEATUREmseBQYNCQ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], + 'schema' => ['title' => 'region id, such as cn-hangzhou', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'ExportType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that is exported. Valid values:'."\n" - ."\n" - .'* transactionLog: transaction logs'."\n" - .'* snapshot: snapshots'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'snapshot', - ], + 'schema' => ['title' => 'Key word of search lossless list', 'description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'spring-boot-sample'], ], [ - 'name' => 'RegionId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'RequestPars', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => 'appId', 'description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'hyaziyb6sc@86827c61f5ed***'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => 'current', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => 'limit', 'description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh-CN', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult'."\n", + 'title' => 'Schema of Response', + 'description' => 'The return value.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '56D9E600-6348-4260-B35F-583413F****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the instance'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ExportType' => [ - 'description' => 'The type of the object that is exported. Valid values:'."\n" - ."\n" - .'* transactionLog: transaction logs'."\n" - .'* snapshot: snapshots'."\n", - 'type' => 'string', - 'example' => 'snapshot', - ], - 'ContentMap' => [ - 'description' => 'The content of a task.'."\n", - 'type' => 'object', - ], - 'Extend' => [ - 'description' => 'The extended information.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* CREATE: The object is being created.'."\n" - .'* RUNNING: The task is running.'."\n" - .'* FINISH: The task is completed.'."\n" - .'* FAILED: The task fails.'."\n" - .'* EXPIRE: The task has expired.'."\n", - 'type' => 'string', - 'example' => 'FINISH', - ], - 'KubeoneTaskIds' => [ - 'description' => 'The ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Id' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'UpdateTime' => [ - 'description' => 'The last update time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '36', 'title' => ''], + 'Results' => [ + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['title' => 'appName', 'description' => 'The application name.', 'type' => 'string', 'example' => 'echo-demo'], + 'AppId' => ['title' => 'appId', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1po62@24810bf4364a***'], + 'Count' => ['title' => 'instance\'s count of app', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Enable' => ['title' => 'rule is open or close', 'description' => 'Indicates whether graceful start is enabled. Valid values:'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'example' => 'true'], + 'WarmupTime' => ['description' => 'The prefetching duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'DelayTime' => ['description' => 'The registration latency. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'FuncType' => ['title' => 'warmup function type, 2 means f(x)=x^2', 'description' => 'The slope of the prefetching curve.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Aligned' => ['title' => 'microservices lifecycle aligns to k8s\'s or NOT', 'description' => 'Indicates whether service registration is complete before readiness probe.', 'type' => 'boolean', 'example' => 'true'], + 'Related' => ['title' => 'K8s\'s HPA is related to warmup or NOT', 'description' => 'Indicates whether service prefetching is complete before readiness probe.', 'type' => 'boolean', 'example' => 'false'], + 'LossLessDetail' => ['title' => 'show lossLess offline&online detail', 'description' => 'Specifies whether to display online and offline processing details.', 'type' => 'boolean', 'example' => 'false'], + 'Notice' => ['title' => 'enable lossLess offline active notification', 'description' => 'Indicates whether notification is enabled.', 'type' => 'boolean', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 36,\\n \\"Results\\": [\\n {\\n \\"AppName\\": \\"echo-demo\\",\\n \\"AppId\\": \\"hkhon1po62@24810bf4364a***\\",\\n \\"Count\\": 3,\\n \\"Enable\\": true,\\n \\"WarmupTime\\": 60,\\n \\"DelayTime\\": 60,\\n \\"FuncType\\": 2,\\n \\"Aligned\\": true,\\n \\"Related\\": false,\\n \\"LossLessDetail\\": false,\\n \\"Notice\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'FetchLosslessRuleList', + 'description' => 'You can call the FetchLosslessRuleList operation to retrieve the configuration rules for graceful start and shutdown.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:FetchLosslessRuleList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"RequestId\\": \\"25EA0A83-9007-4E87-808C-637BE1A****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ExportType\\": \\"snapshot\\",\\n \\"ContentMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Extend\\": \\"{}\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"KubeoneTaskIds\\": \\"10\\",\\n \\"Id\\": 1,\\n \\"CreateTime\\": 1631001140913,\\n \\"UpdateTime\\": 1632979237663\\n }\\n}","type":"json"}]', - 'title' => 'ExportZookeeperData', - 'description' => 'Only one task can run at a time.'."\n", ], - 'ListExportZookeeperData' => [ - 'summary' => 'Lists historical data export tasks of a Microservices Engine (MSE) Zookeeper instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GatewayBlackWhiteList' => [ + 'summary' => 'Retrieves the gateway blacklists and whitelists.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -18016,977 +11383,753 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2d1****', - ], + 'schema' => ['description' => 'The page number. Value range: integers greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'FilterParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => 'parse from filterParams', + 'description' => 'parse from filterParams', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique identifier of the gateway (when both GatewayId and GatewayUniqueId exist, GatewayId takes precedence).', 'type' => 'string', 'required' => false, 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'ResourceType' => ['description' => 'Not available for use yet.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + 'Type' => ['description' => 'Not available for use yet.', 'type' => 'string', 'required' => false, 'example' => ' ""', 'title' => ''], + 'IsWhite' => ['description' => 'Not available for use yet.', 'type' => 'boolean', 'required' => false, 'example' => ' ""', 'title' => ''], + 'SearchType' => ['description' => 'Search type:'."\n" + ."\n" + .'- ROUTE: Search by route, fill in the route name in SearchContent'."\n" + ."\n" + .'- DOMAIN: Search by domain name, fill in the domain name in SearchContent'."\n" + ."\n" + .'- IP: Search by specified IP, fill in the IP in SearchContent', 'type' => 'string', 'required' => false, 'example' => 'IP', 'title' => ''], + 'SearchContent' => ['description' => 'Search content.', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1', 'title' => ''], + ], 'required' => false, - 'example' => '10', - 'default' => '5', + 'example' => '', ], ], + [ + 'name' => 'OrderItem', + 'in' => 'query', + 'schema' => ['description' => 'Not available for use yet.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => ['description' => 'Not available for use yet.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => '""', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'BaseResult>', - 'description' => 'BaseResult\\'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', 'title' => ''], + 'Success' => ['description' => 'The result of the request. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The code is only used to synchronize with success', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'DynamicCode' => ['description' => 'The placeholder in dynamic error messages. Not in use currently, please ignore.', 'type' => 'string', 'title' => '', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'Dynamic message. Not in use currently, please ignore.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the instance'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ExportType' => [ - 'description' => 'The type of the object that is exported. Valid values:'."\n" - ."\n" - .'* transactionLog: transaction logs'."\n" - .'* snapshot: snapshots'."\n", - 'type' => 'string', - 'example' => 'snapshot', - ], - 'ContentMap' => [ - 'description' => 'The details of the task.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Extend' => [ - 'description' => 'The extension information that is in the JSON format. The extension information facilitates addition of parameters.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* CREATE: The task is being created.'."\n" - .'* RUNNING: The task is being executed.'."\n" - .'* FINISH: The task is completed.'."\n" - .'* FAILED: The task failed.'."\n" - .'* EXPIRE: The task has expired.'."\n", - 'type' => 'string', - 'example' => 'FINISH', - ], - 'KubeoneTaskIds' => [ - 'description' => 'The ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Id' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'UpdateTime' => [ - 'description' => 'The time when the task was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the instance list', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalSize' => ['description' => 'The total number of instances found', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of rows per page set during input', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Result' => [ + 'description' => 'The returned collection.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The blacklist or whitelist ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'ResourceType' => ['description' => 'Effective granularity:'."\n" + ."\n" + .'- GATEWAY: Gateway global'."\n" + ."\n" + .'- DOMAIN: Domain name'."\n" + ."\n" + .'- ROUTE: Route', 'type' => 'string', 'example' => 'GATEWAY', 'title' => ''], + 'Content' => ['description' => 'The blacklist content.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'IsWhite' => ['description' => 'Indicates whether it is a whitelist.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Type' => ['description' => 'The blacklist or whitelist type, currently fixed as IP blacklist or whitelist.', 'type' => 'string', 'example' => 'IP', 'title' => ''], + 'Status' => ['description' => 'The blacklist or whitelist status.'."\n" + ."\n" + .'- on: Enabled'."\n" + ."\n" + .'- off: Disabled', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '81', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique identifier of the gateway.', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-08-02T02:43:40.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2024-08-02T02:43:40.000+0000', 'title' => ''], + 'ResourceIdJsonList' => ['description' => 'The JSON list of resource IDs.'."\n" + ."\n" + .'- If ResourceType is ROUTE, this is a list of route IDs'."\n" + ."\n" + .'- If ResourceType is DOMAIN, this is a list of domain name IDs', 'type' => 'string', 'example' => '[234]', 'title' => ''], + 'Note' => ['description' => 'The remarks.', 'type' => 'string', 'example' => 'Blocked IP list', 'title' => ''], + 'ResourceIdNameJson' => ['description' => 'The resource name description.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Name' => ['description' => 'The blacklist name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 1,\\n \\"Result\\": [\\n {\\n \\"Id\\": 549,\\n \\"ResourceId\\": 549,\\n \\"ResourceType\\": \\"GATEWAY\\",\\n \\"Content\\": \\"1.1.1.1\\",\\n \\"IsWhite\\": true,\\n \\"Type\\": \\"IP\\",\\n \\"Status\\": \\"on\\",\\n \\"GatewayId\\": 81,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GmtCreate\\": \\"2024-08-02T02:43:40.000+0000\\",\\n \\"GmtModified\\": \\"2024-08-02T02:43:40.000+0000\\",\\n \\"ResourceIdJsonList\\": \\"[234]\\",\\n \\"Note\\": \\"Blocked IP list\\",\\n \\"ResourceIdNameJson\\": \\"{}\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GatewayBlackWhiteList', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GatewayBlackWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ExportType\\": \\"snapshot\\",\\n \\"ContentMap\\": \\"{}\\",\\n \\"Extend\\": \\"{}\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"KubeoneTaskIds\\": \\"10\\",\\n \\"Id\\": 1,\\n \\"CreateTime\\": 1631001140913,\\n \\"UpdateTime\\": 1632979237663\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListExportZookeeperData', ], - 'CreateZnode' => [ - 'summary' => 'Creates a znode.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetAppMessageQueueRoute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '17007', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The region where the instance resides. Examples:'."\n" + ."\n" + .'* `cn-hangzhou`: China (Hangzhou)'."\n" + .'* `cn-beijing`: China (Beijing)'."\n" + .'* `cn-shanghai`: China (Shanghai)'."\n" + .'* `cn-zhangjiakou`: China (Zhangjiakou)'."\n" + .'* `cn-shenzhen`: China (Shenzhen)'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Path', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hkhon1po62@c3df23522baa898'], ], [ - 'name' => 'Data', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'data', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4B00BCB0-105F-5A2A-B75B-641C8E9B18FC'], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success'], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'example' => '/', - ], - 'Dir' => [ - 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" - ."\n" - .'* `true`: The node information was returned.'."\n" - .'* `false`: The node information failed to be returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'AppId' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => 'hkhon1po62@54e1f42f37cd65a'], + 'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Enable' => ['description' => 'Indicates whether the canary release for messaging feature is enabled.'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Tags' => [ + 'description' => 'The tags used to ignore message consumption for nodes in untagged environments.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tag used to ignore message consumption for nodes in untagged environments.'."\n", 'type' => 'string', 'example' => 'gray'], ], - 'Name' => [ - 'description' => 'The name of the node.'."\n", + 'FilterSide' => [ + 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => ['Server', 'Client'], ], ], ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false. The value true indicates that the request was successful. The value false indicates that the request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ZooKeeper.IllegalRequest', - 'errorMessage' => 'ZooKeeper operation is illegal.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', - 'errorMessage' => 'No permission to operate current Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', - 'errorMessage' => 'The current instance already has this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', - 'errorMessage' => 'The current instance does not have this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.Timeout', - 'errorMessage' => 'ZooKeeper operation timeout.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4B00BCB0-105F-5A2A-B75B-641C8E9B18FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"hkhon1po62@54e1f42f37cd65a\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Enable\\": true,\\n \\"Tags\\": [\\n \\"gray\\"\\n ],\\n \\"FilterSide\\": \\"Server\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetAppMessageQueueRoute', + 'summary' => 'Queries information about canary release for messaging of an application.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetAppMessageQueueRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n200\\nDC34E4A3-5F1C-4E40-86EA-02EDF967****\\n请求处理成功\\n\\n /\\n cluster\\n true\\n mse-bc1a29b0-160230875****-reg-center-0-1\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'CreateZnode', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteZnode' => [ - 'summary' => 'Deletes a ZooKeeper node.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetApplicationInstanceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17014', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17021', + 'abilityTreeNodes' => ['FEATUREmseZB84VG'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '', 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'ClusterId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['title' => '', 'description' => 'The application name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 100], ], [ - 'name' => 'Path', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => true, 'example' => 'abcde@12345'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tags that you want to add to nodes.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gray'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', 'default' => '10'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'title' => '', + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'example' => '/', - ], - 'Dir' => [ - 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" - ."\n" - .'* `true`: The node information was returned.'."\n" - .'* `false`: The node information failed to be returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + 'Result' => [ + 'title' => '', + 'description' => 'The queried nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Ip' => ['title' => '', 'description' => 'The node IP address.'."\n", 'type' => 'string', 'example' => '10.1.2.3'], + 'Tags' => [ + 'title' => '', + 'description' => 'The node tags.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tag' => ['title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'gray'], + ], + ], + ], + 'Port' => ['title' => '', 'description' => 'The application port.'."\n", 'type' => 'string', 'example' => '8080'], + ], + ], ], + 'TotalSize' => ['title' => '', 'description' => 'The total number of nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageNumber' => ['title' => '', 'description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ZooKeeper.Timeout', - 'errorMessage' => 'ZooKeeper operation timeout.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', - 'errorMessage' => 'The current instance does not have this Znode.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Ip\\": \\"10.1.2.3\\",\\n \\"Tags\\": [\\n {\\n \\"Tag\\": \\"gray\\"\\n }\\n ],\\n \\"Port\\": \\"8080\\"\\n }\\n ],\\n \\"TotalSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'GetApplicationInstanceList', + 'summary' => 'Queries the list of microservice application instances.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationInstanceList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n200\\nDC34E4A3-5F1C-4E40-86EA-02EDF967****\\n请求处理成功\\n\\n /\\n cluster\\n true\\n mse-bc1a29b0-160230875****-reg-center-0-1\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'DeleteZnode', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateZnode' => [ - 'summary' => 'Updates the information about a ZooKeeper node.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetApplicationList' => [ + 'summary' => 'Retrieves the list of applications.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17105', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], - 'autoTest' => true, + 'operationType' => 'get', + 'abilityTreeCode' => '17022', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rest-container', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'hkhon1po62@c3df23522b*****', 'title' => ''], ], [ - 'name' => 'Data', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'data', - ], + 'schema' => ['description' => 'The source of the application. The value is fixed as edasmsc.', 'type' => 'string', 'required' => false, 'example' => 'edasmsc', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The programming language, such as Java or Go.', 'type' => 'string', 'required' => false, 'example' => 'Java', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to enable the switch.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SentinelEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to enable the Sentinel component.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'maxLength' => 64, 'default' => 'default', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The custom tag key. It can contain up to 128 characters and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'tagKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'tagValue', 'title' => ''], + ], + 'description' => 'The tag.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'maxItems' => 20, + 'description' => 'Alibaba Cloud tags. You can perform filtering by Alibaba Cloud tag.', 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F55E608F-7C15-****-9CFD-DF832EBC4A0F', 'title' => ''], + 'Data' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The information about the applications.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ExtraInfo' => ['description' => 'The additional information.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'finance', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1po62@5f1b08becb*****', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'InstancesNumber' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Source' => ['description' => 'The source of the application.', 'type' => 'string', 'example' => 'edasmsc', 'title' => ''], + 'Language' => ['description' => 'The programming language of the application.', 'type' => 'string', 'example' => 'JAVA', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Tags' => ['description' => 'The Alibaba Cloud tags.', 'type' => 'object', 'example' => '{"tagKey1":"tagValue1","tagKey2":"tagValue2"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ZooKeeper.IllegalRequest', - 'errorMessage' => 'ZooKeeper operation is illegal.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', - 'errorMessage' => 'No permission to operate current Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', - 'errorMessage' => 'The current instance already has this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', - 'errorMessage' => 'The current instance does not have this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.Timeout', - 'errorMessage' => 'ZooKeeper operation timeout.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"F55E608F-7C15-****-9CFD-DF832EBC4A0F\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Status\\": 0,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"AppName\\": \\"finance\\",\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"InstancesNumber\\": 1,\\n \\"Source\\": \\"edasmsc\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\",\\n \\"Tags\\": {\\n \\"tagKey1\\": \\"tagValue1\\",\\n \\"tagKey2\\": \\"tagValue2\\"\\n }\\n }\\n ],\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'GetApplicationList', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n316F5F64-F73D-42DC-8632-01E308B6****\\n请求处理成功\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'UpdateZnode', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'translator' => 'manual', ], - 'ListZnodeChildren' => [ - 'summary' => 'Queries the child nodes of a ZooKeeper node.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetBlackWhiteList' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '17075', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '36934', + 'abilityTreeNodes' => ['FEATUREmseWSG2U5'], ], 'parameters' => [ [ - 'name' => 'Path', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['description' => 'The type of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GATEWAY'], ], [ - 'name' => 'ClusterId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'IP'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gw-32d5c9769c1842b1a2cc3426c59e****'], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the whitelist.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '89CBC928-4F57-51FA-A413-EE0F4CD87200'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation. '], + 'Code' => ['description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'example' => '/zookeeper', - ], - 'Dir' => [ - 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" - ."\n" - .'* `true`: The node information was returned.'."\n" - .'* `false`: The node information failed to be returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', - ], - ], + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '275'], + 'ResourceId' => ['description' => 'The ID of the resource.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ResourceType' => ['description' => 'The type of a resource.'."\n", 'type' => 'string', 'example' => 'GATEWAY'], + 'Content' => ['description' => 'The content of the blacklist.'."\n", 'type' => 'string', 'example' => 'text'], + 'Type' => ['description' => 'The type.'."\n", 'type' => 'string', 'example' => 'IP'], + 'IsWhite' => ['description' => 'Indicates whether the whitelist is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Status' => ['description' => 'The status of the blacklist or whitelist.'."\n", 'type' => 'string', 'example' => 'on'], + 'GatewayId' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], ], ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ZooKeeper.IllegalRequest', - 'errorMessage' => 'ZooKeeper operation is illegal.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', - 'errorMessage' => 'No permission to operate current Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', - 'errorMessage' => 'The current instance already has this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', - 'errorMessage' => 'The current instance does not have this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.Timeout', - 'errorMessage' => 'ZooKeeper operation timeout.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****\\",\\n \\"Data\\": [\\n {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/zookeeper\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\nBDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****\\n\\n /zookeeper\\n cluster\\n true\\n mse-bc1a29b0-160230875****-reg-center-0-1\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'ListZnodeChildren', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryZnodeDetail' => [ - 'summary' => 'Queries the information about a ZooKeeper node.', - 'methods' => [ - 'get', - 'post', + 'substitutions' => ['mse::2019-05-31::GatewayBlackWhiteList'], ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89CBC928-4F57-51FA-A413-EE0F4CD87200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. \\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 275,\\n \\"ResourceId\\": 1,\\n \\"ResourceType\\": \\"GATEWAY\\",\\n \\"Content\\": \\"text\\",\\n \\"Type\\": \\"IP\\",\\n \\"IsWhite\\": true,\\n \\"Status\\": \\"on\\",\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetBlackWhiteList', + 'summary' => 'Queries the blacklist or whitelist of a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'GetEngineNamepace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -18996,67 +12139,32 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '17085', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], + 'abilityTreeCode' => '17029', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended request parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'ClusterId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'The destination ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0e958d79-****-b282-b702d66362b5'], ], [ - 'name' => 'Path', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse.cn-hangzhou.aliyuncs.com'], ], [ - 'name' => 'InstanceId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-5bffa4e8630', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-98s****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -19065,131 +12173,66 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'example' => '/zookeeper', - ], - 'Dir' => [ - 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" - ."\n" - .'* `true`: The node information was returned.'."\n" - .'* `false`: The node information failed to be returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'zookeeper', - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202'], + 'Type' => ['description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* 0: global configuration'."\n" + .'* 1: default namespace'."\n" + .'* 2: custom namespace'."\n", 'type' => 'string', 'example' => '1'], + 'Quota' => ['description' => 'The quota of configurations.'."\n", 'type' => 'string', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FA8F966F-420C-52F5-B49E-6ED7CCE02697'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'ConfigCount' => ['description' => 'The number of configurations.'."\n", 'type' => 'string', 'example' => '1'], + 'NamespaceShowName' => ['description' => 'The display name of the namespace.'."\n", 'type' => 'string', 'example' => 'public'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'NamespaceDesc' => ['description' => 'The description of the namespace.'."\n", 'type' => 'string', 'example' => 'mytest'], + 'Namespace' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => 'public'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ZooKeeper.Timeout', - 'errorMessage' => 'ZooKeeper operation timeout.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', - 'errorMessage' => 'The current instance does not have this Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', - 'errorMessage' => 'No permission to operate current Znode.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest', - 'errorMessage' => 'ZooKeeper operation is illegal.', - ], - [ - 'errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', - 'errorMessage' => 'The current instance already has this Znode.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Type\\": \\"1\\",\\n \\"Quota\\": \\"200\\",\\n \\"RequestId\\": \\"FA8F966F-420C-52F5-B49E-6ED7CCE02697\\",\\n \\"Message\\": \\"success\\",\\n \\"ConfigCount\\": \\"1\\",\\n \\"NamespaceShowName\\": \\"public\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"Namespace\\": \\"public\\"\\n}","type":"json"}]', + 'title' => 'GetEngineNamepace', + 'summary' => 'Queries the namespaces of a Nacos instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetEngineNamepace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Data\\": {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/zookeeper\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"zookeeper\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n请求处理成功\\n58E06A0A-BD2C-47A0-99C2-B100F353****\\n\\n /zookeeper\\n cluster\\n true\\n zookeeper\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', - 'title' => 'QueryZnodeDetail', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListZkTrack' => [ - 'summary' => 'Obtains the track data of a ZooKeeper instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGateway' => [ + 'summary' => 'Obtains the basic information about a gateway, such as the virtual private cloud (VPC) and vSwitch to which the gateway belongs.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -19198,352 +12241,178 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '150858', - 'abilityTreeNodes' => [ - 'FEATUREmseN84UZV', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '92862', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-0ju2yq****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-685f661467b54f48b7b7a76605ce****', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/path', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x301fdfbdbf00***', - ], - ], - [ - 'name' => 'StartTs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1669618483', - ], - ], - [ - 'name' => 'EndTs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1669619383', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Reverse', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable reverse ordering.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Traces' => [ - 'description' => 'The track data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'LogDate' => [ - 'description' => 'The logging time.'."\n", - 'type' => 'string', - 'example' => '2022-11-28 15:09:15,606', - ], - 'Timestamp' => [ - 'description' => 'The timestamp. It is not available.'."\n", - 'type' => 'string', - 'example' => '1669619383000', - ], - 'SessionId' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'example' => '0x301fdfbdbf00***', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/path', - ], - 'TraceType' => [ - 'title' => '轨迹类型：push、pull、notify', - 'description' => 'The type of the trajectory. Valid values:'."\n" - ."\n" - .'* Push'."\n" - .'* Pull'."\n" - .'* Notify'."\n", - 'type' => 'string', - 'example' => 'Push', - ], - 'OpType' => [ - 'title' => '操作类型'."\n" - .'对于Push'."\n" - .' ○ Create'."\n" - .' ○ Update'."\n" - .' ○ Delete'."\n" - .' ○ SetAcl'."\n" - .' ○ Multi'."\n" - .'对于Pull'."\n" - .' ○ GetData'."\n" - .' ○ GetChild'."\n" - .' ○ GetStat', - 'description' => 'The type of the operation. For trajectory of the Push type:'."\n" - ."\n" - .'* Create'."\n" - .'* Update'."\n" - .'* Delete'."\n" - .'* SetAcl'."\n" - .'* Multi'."\n" - ."\n" - .'For trajectory of the Pull type:'."\n" - ."\n" - .'* GetData'."\n" - .'* GetChild'."\n" - .'* GetStat'."\n", - 'type' => 'string', - 'example' => 'Create', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the gateway.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Name' => ['description' => 'The name of the gateway.'."\n", 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', 'title' => ''], + 'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'PrimaryUser' => ['description' => 'The Alibaba Cloud account ID of the user who created the gateway.'."\n", 'type' => 'string', 'example' => '1231254', 'title' => ''], + 'Status' => ['description' => 'The status of the gateway. Valid values:'."\n" + ."\n" + .'* 0: The gateway is being created.'."\n" + .'* 1: The gateway fails to be created.'."\n" + .'* 2: The gateway is running.'."\n" + .'* 3: The gateway is changing.'."\n" + .'* 4: The gateway is scaling in.'."\n" + .'* 6: The gateway is scaling out.'."\n" + .'* 8: The gateway is being deleted.'."\n" + .'* 10: The gateway is restarting.'."\n" + .'* 11: The gateway is being rebuilt.'."\n" + .'* 12: The gateway is updating.'."\n" + .'* 13: The gateway fails to be updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Vpc' => ['description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-bp1328cm01m6uel42b5zb', 'title' => ''], + 'Vswitch' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', 'title' => ''], + 'SecurityGroup' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'example' => 'sg-bp11ufzqn6mmb8dtzz82', 'title' => ''], + 'Spec' => ['description' => 'The specifications of the gateway.'."\n", 'type' => 'string', 'example' => 'MSE_GTW_16_32_200_c', 'title' => ''], + 'Replica' => ['description' => 'The number of gateway replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the gateway was created. The time is displayed in GMT. The time is the local time of the region in which the gateway resides.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the gateway was last modified.'."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'XtraceDetails' => [ + 'description' => 'The details of Tracing Analysis.'."\n", + 'type' => 'object', + 'properties' => [ + 'Sample' => ['description' => 'The sampling rate of Tracing Analysis.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TraceOn' => ['description' => 'Indicates whether sampling by using Tracing Analysis is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'EventType' => [ - 'title' => '事件类型'."\n" - .'对于notify：'."\n" - .' ○ NodeCreated'."\n" - .' ○ NodeDeleted'."\n" - .' ○ NodeDataChanged'."\n" - .' ○ NodeChildrenChanged', - 'description' => 'The type of the event. For trajectory of the Notify type:'."\n" - ."\n" - .'* NodeCreated'."\n" - .'* NodeDeleted'."\n" - .'* NodeDataChanged'."\n" - .'* NodeChildrenChanged'."\n", - 'type' => 'string', - 'example' => 'NodeCreated', + 'title' => '', + 'example' => '', + ], + 'Vswitch2' => ['description' => 'The ID of the secondary vSwitch.'."\n", 'type' => 'string', 'example' => 'vpc-bp1j6ivhav15ve7q54kq2', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'EndDate' => ['description' => 'The time when the gateway expires.'."\n", 'type' => 'string', 'example' => '2021-08-01 00:00:00', 'title' => ''], + 'StatusDesc' => ['description' => 'The description of the status.'."\n", 'type' => 'string', 'example' => 'Restarting', 'title' => ''], + 'LogConfigDetails' => [ + 'description' => 'The log configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogEnabled' => ['description' => 'Indicates whether Log Service is activated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the project.'."\n", 'type' => 'string', 'example' => 'k8s-log-c173117256e934a96b7fefdf2ef8a8057', 'title' => ''], + 'LogStoreName' => ['description' => 'The name of the Logstore.'."\n", 'type' => 'string', 'example' => 'mse_access_log', 'title' => ''], ], - 'DataType' => [ - 'title' => '数据类型：persist、ephemeral', - 'description' => 'The data type. Valid values:'."\n" + 'title' => '', + 'example' => '', + ], + 'MseTag' => ['description' => 'The tag of the resource.'."\n", 'type' => 'string', 'example' => '{"TagKey":"TagValue"}', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfm34x43l*****', 'title' => ''], + 'TotalReplica' => ['description' => 'The total number of replicas, including the number of replicas that are automatically scaled out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Elastic' => ['description' => 'Indicates whether auto scale-out is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ElasticReplica' => ['description' => 'The number of replicas that are automatically scaled out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ElasticType' => ['description' => 'The type of auto scale-out. Valid value:'."\n" + ."\n" + .'* CronHPA: scale-out by time'."\n", 'type' => 'string', 'example' => 'CronHPA', 'title' => ''], + 'ElasticPolicy' => [ + 'description' => 'The auto scale-out policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxReplica' => ['description' => 'The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'ElasticType' => ['description' => 'The type of auto scale-out. Valid value:'."\n" ."\n" - .'* persist'."\n" - .'* ephemeral'."\n", - 'type' => 'string', - 'example' => 'persist', - ], - 'Watch' => [ - 'title' => '监听', - 'description' => 'Indicates whether the monitoring feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Acl' => [ - 'description' => 'The access control list (ACL).'."\n", - 'type' => 'string', - 'example' => 'world:anyone:cdrwa', - ], - 'MultiSize' => [ - 'description' => 'The transaction size.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Ttl' => [ - 'description' => 'The time to live (TTL).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Finished' => [ - 'description' => 'Indicates whether the transaction ended.'."\n", - 'type' => 'boolean', - 'example' => 'true', + .'* CronHPA: scale-out by time'."\n", 'type' => 'string', 'example' => 'CronHPA', 'title' => ''], + 'TimePolicyList' => [ + 'description' => 'The policy of scale-out by time.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesiredReplica' => ['description' => 'The number of expected replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'StartTime' => ['description' => 'The start time of auto scale-out.'."\n", 'type' => 'string', 'example' => '16:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of auto scale-out.'."\n", 'type' => 'string', 'example' => '18:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'."\n", - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"DEFAULT\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"1231254\\",\\n \\"Status\\": 0,\\n \\"Vpc\\": \\"vpc-bp1328cm01m6uel42b5zb\\",\\n \\"Vswitch\\": \\"vsw-bp18zeqxx6mpuq843z4n5\\",\\n \\"SecurityGroup\\": \\"sg-bp11ufzqn6mmb8dtzz82\\",\\n \\"Spec\\": \\"MSE_GTW_16_32_200_c\\",\\n \\"Replica\\": 1,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"XtraceDetails\\": {\\n \\"Sample\\": 10,\\n \\"TraceOn\\": true\\n },\\n \\"Vswitch2\\": \\"vpc-bp1j6ivhav15ve7q54kq2\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"StatusDesc\\": \\"Restarting\\",\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"k8s-log-c173117256e934a96b7fefdf2ef8a8057\\",\\n \\"LogStoreName\\": \\"mse_access_log\\"\\n },\\n \\"MseTag\\": \\"{\\\\\\"TagKey\\\\\\":\\\\\\"TagValue\\\\\\"}\\",\\n \\"ResourceGroupId\\": \\"rg-acfm34x43l*****\\",\\n \\"TotalReplica\\": 3,\\n \\"Elastic\\": true,\\n \\"ElasticReplica\\": 1,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"ElasticPolicy\\": {\\n \\"MaxReplica\\": 5,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"TimePolicyList\\": [\\n {\\n \\"DesiredReplica\\": 2,\\n \\"StartTime\\": \\"16:00\\",\\n \\"EndTime\\": \\"18:00\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetGateway', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGateway', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"LogDate\\": \\"2022-11-28 15:09:15,606\\",\\n \\"Timestamp\\": \\"1669619383000\\",\\n \\"SessionId\\": \\"0x301fdfbdbf00***\\",\\n \\"Path\\": \\"/path\\",\\n \\"TraceType\\": \\"Push\\",\\n \\"OpType\\": \\"Create\\",\\n \\"EventType\\": \\"NodeCreated\\",\\n \\"DataType\\": \\"persist\\",\\n \\"Watch\\": true,\\n \\"Acl\\": \\"world:anyone:cdrwa\\",\\n \\"MultiSize\\": 3,\\n \\"Result\\": \\"success\\",\\n \\"Ttl\\": 0,\\n \\"Finished\\": true\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\\\n\\",\\n \\"Message\\": \\"ok\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListZkTrack', ], - 'ListSentinelBlockFallbackDefinitions' => [ - 'summary' => 'Obtains the custom behavior of traffic protection.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGatewayAuthConsumerDetail' => [ + 'summary' => 'Queries the details of the consumer on which a gateway performs authentication operations.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -19551,401 +12420,449 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '163990', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClassificationSet', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '行为类型列表。', - 'description' => 'Behavior Classification Set.', - 'type' => 'array', - 'items' => [ - 'title' => '行为类型。', - 'description' => 'Behavior classification.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => 'web', - 'rpc', - ], - 'example' => '1', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The name of the Microservices namespace.', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-1a4ab101d5924b6f92c5ec98a84*****', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '120', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'title' => '行为信息。', - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '行为ID。', - 'description' => 'Behavior Id', - 'type' => 'string', - 'example' => '12', - ], - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The name of the Microservices namespace.', - 'type' => 'string', - 'example' => 'default', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Name' => [ - 'title' => '行为名称。', - 'description' => 'The name of the behavior.', - 'type' => 'string', - 'example' => 'defaultFallback', - ], - 'ResourceClassification' => [ - 'title' => '行为类型。', - 'description' => 'Behavior classification.', - 'type' => 'string', - 'example' => '1', - ], - 'FallbackBehavior' => [ - 'title' => '行为详情。', - 'description' => 'Behavior detail.', - 'type' => 'object', - 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}', - ], - 'TargetMap' => [ - 'title' => '与该行为绑定的资源信息。', - 'description' => 'Resource information bound to the behavior.', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Name' => ['description' => 'The name of the consumer.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ConsumerStatus' => ['description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'PrimaryUser' => ['description' => 'The creator.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', 'title' => ''], + 'Type' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", 'type' => 'string', 'example' => 'JWT', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the consumer authentication record was created.'."\n", 'type' => 'string', 'example' => '2023-02-01 14:17:57', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the consumer authentication record was modified.'."\n", 'type' => 'string', 'example' => '2023-03-01 14:17:57', 'title' => ''], + 'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'EncodeType' => ['description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* RSA'."\n" + .'* OCT'."\n", 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'Jwks' => ['description' => 'The JWT public key. The JSON format is supported.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "keys": ['."\n" + .' {'."\n" + .' "e": "AQAB",'."\n" + .' "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ",'."\n" + .' "kty": "RSA",'."\n" + .' "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'TokenName' => ['description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'example' => 'Authorization', 'title' => ''], + 'TokenPass' => ['description' => 'Specifies whether to enable pass-through.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TokenPosition' => ['description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'example' => 'HEADER', 'title' => ''], + 'TokenPrefix' => ['description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'example' => 'Bearer ', 'title' => ''], + 'KeyName' => ['description' => 'The name of the key used for JWT-based identity authentication.'."\n", 'type' => 'string', 'example' => 'iss', 'title' => ''], + 'KeyValue' => ['description' => 'The value of the key used for JWT-based identity authentication.'."\n", 'type' => 'string', 'example' => 'abcd', 'title' => ''], + 'ResourceList' => [ + 'description' => 'The resource list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource list.'."\n", 'type' => 'object', - 'example' => '{"/params/{hot}":[1]}', + 'properties' => [ + 'Id' => ['description' => 'The ID of the authorized resource for the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'ConsumerId' => ['description' => 'The consumer ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'RouteId' => ['description' => 'The ID of the route.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3458', 'title' => ''], + 'RouteName' => ['description' => 'The name of the route.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ResourceStatus' => ['description' => 'The resource authorization state. Valid values:'."\n" + ."\n" + .'* true: Resource authorization is enabled.'."\n" + .'* false: Resource authorization is disabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-4822033a8513496fa10f05c934f*****', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the resource associated with the consumer authentication record was created.'."\n", 'type' => 'string', 'example' => '2022-12-06 01:38:03', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the resource associated with the consumer authentication record was modified.'."\n", 'type' => 'string', 'example' => '2022-12-06 01:38:03', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"ConsumerStatus\\": true,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"Type\\": \\"JWT\\",\\n \\"GmtCreate\\": \\"2023-02-01 14:17:57\\",\\n \\"GmtModified\\": \\"2023-03-01 14:17:57\\",\\n \\"Description\\": \\"Description\\",\\n \\"EncodeType\\": \\"RSA\\",\\n \\"Jwks\\": \\"{\\\\n \\\\\\"keys\\\\\\": [\\\\n {\\\\n \\\\\\"e\\\\\\": \\\\\\"AQAB\\\\\\",\\\\n \\\\\\"kid\\\\\\": \\\\\\"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\\\\\\",\\\\n \\\\\\"kty\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"n\\\\\\": \\\\\\"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"TokenName\\": \\"Authorization\\",\\n \\"TokenPass\\": true,\\n \\"TokenPosition\\": \\"HEADER\\",\\n \\"TokenPrefix\\": \\"Bearer \\",\\n \\"KeyName\\": \\"iss\\",\\n \\"KeyValue\\": \\"abcd\\",\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 16,\\n \\"ConsumerId\\": 123,\\n \\"RouteId\\": 3458,\\n \\"RouteName\\": \\"test\\",\\n \\"ResourceStatus\\": true,\\n \\"GatewayUniqueId\\": \\"gw-4822033a8513496fa10f05c934f*****\\",\\n \\"GmtCreate\\": \\"2022-12-06 01:38:03\\",\\n \\"GmtModified\\": \\"2022-12-06 01:38:03\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayAuthConsumerDetail', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayAuthConsumerDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"12\\",\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Name\\": \\"defaultFallback\\",\\n \\"ResourceClassification\\": \\"1\\",\\n \\"FallbackBehavior\\": {\\n \\"webRespStatusCode\\": 429,\\n \\"webRespMessage\\": \\"test\\",\\n \\"webFallbackMode\\": 0,\\n \\"webRespContentType\\": 0\\n },\\n \\"TargetMap\\": {\\n \\"/params/{hot}\\": [\\n 1\\n ]\\n }\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListSentinelBlockFallbackDefinitions', ], - 'BindSentinelBlockFallbackDefinition' => [ - 'summary' => 'Binds traffic protection behavior.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGatewayAuthDetail' => [ + 'summary' => 'Retrieves the authentication details of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '164017', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '37108', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The microservice namespace.', - 'type' => 'string', - 'required' => true, - 'example' => 'prod', - ], - ], - [ - 'name' => 'FallbackId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '行为ID。', - 'description' => 'Behavior ID. 0:the default behavior.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21', - ], + 'schema' => ['description' => 'The authentication ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1100', 'title' => '', 'required' => false], ], [ - 'name' => 'TargetType', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'title' => '目标规则类型。', - 'description' => 'Target rule type.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - '', - 4 => '', - 6 => '', - 11 => '', - ], - 'example' => '1', - ], + 'schema' => ['description' => 'The gateway ID. Specify this parameter or `GatewayUniqueId`.', 'type' => 'integer', 'format' => 'int64', 'example' => '2274', 'title' => '', 'required' => false], ], [ - 'name' => 'Resource', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => 'Interface Name: The resource to which the rule applies. It must match the interface name in the console\'s interface details.', - 'type' => 'string', - 'required' => true, - 'example' => '/a', - ], + 'schema' => ['description' => 'The unique gateway ID. Specify this parameter or `GatewayId`. If both are specified, `GatewayUniqueId` takes precedence.', 'type' => 'string', 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- `zh` (default): Chinese'."\n" + ."\n" + .'- `en`: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => 'The response message.', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The response code. This value is synchronized with the `Success` parameter. When `Success` is `true`, the value of this parameter is `200`.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'title' => '返回详情。', - 'description' => 'The returned data.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '状态码。', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'description' => 'The details of the authentication.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The authentication ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1100', 'title' => ''], + 'Name' => ['description' => 'The name of the authentication.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the associated gateway.', 'type' => 'string', 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', 'title' => ''], + 'GatewayId' => ['description' => 'The ID of the associated gateway.', 'type' => 'integer', 'format' => 'int64', 'example' => '2274', 'title' => ''], + 'Type' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'- `JWT`'."\n" + ."\n" + .'- `OIDC`'."\n" + ."\n" + .'- `IDaaS`'."\n" + ."\n" + .'- `ExternalAuthZ`: Represents a custom authentication service.', 'type' => 'string', 'example' => 'JWT', 'title' => ''], + 'Issuer' => ['description' => 'The token issuer. This parameter is returned only if the authentication type is `JWT` or `OIDC`.'."\n" + ."\n" + .'- If the type is `JWT`, this parameter indicates the issuer (`iss`) of the JWT claims.'."\n" + ."\n" + .'- If the type is `OIDC`, this parameter indicates the issuer (`iss`) of the OIDC claims.', 'type' => 'string', 'example' => 'https://example.com/auth', 'title' => ''], + 'Jwks' => ['description' => 'The JWT public key, in JSON format.', 'type' => 'string', 'example' => '{\\n \\"keys\\":[\\n {\\n \\"kty\\": \\"RSA\\",\\n \\"e\\": \\"AQAB\\",\\n \\"use\\": \\"sig\\",\\n \\"kid\\": \\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\",\\n \\"alg\\": \\"RS256\\",\\n \\"n\\": \\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\"\\n }\\n ]\\n}\\n', 'title' => ''], + 'IsWhite' => ['description' => 'The authorization mode.'."\n" + ."\n" + .'- `true`: whitelist mode. Requests for the hosts and paths in the list can bypass authentication. All other requests require authentication.'."\n" + ."\n" + .'- `false`: blacklist mode. Requests for the hosts and paths in the list require authentication. All other requests can bypass authentication.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'GmtCreate' => ['description' => 'The time when the authentication was created, in GMT.', 'type' => 'string', 'example' => '2024-02-19T02:41:03.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the authentication was last modified, in GMT.', 'type' => 'string', 'example' => '2024-02-19T02:41:03.000+0000', 'title' => ''], + 'TokenPosition' => ['description' => 'The location of the JWT.'."\n" + ."\n" + .'- `HEADER`: The token is passed in a request header.', 'type' => 'string', 'example' => 'HEADER', 'title' => ''], + 'TokenName' => ['description' => 'The name of the request header that carries the token. Typically, this is `Authorization`.', 'type' => 'string', 'example' => 'Authorization', 'title' => ''], + 'TokenNamePrefix' => ['description' => 'The prefix of the JWT token.', 'type' => 'string', 'example' => 'Bearer ', 'title' => ''], + 'TokenPass' => ['description' => 'Specifies whether to pass the token to the backend service after authentication.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Status' => ['description' => 'Indicates whether authentication is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'RedirectUrl' => ['description' => 'The redirect URL for successful OIDC or IDaaS authentication. This URL must match the one configured in your identity provider.', 'type' => 'string', 'example' => 'https://yourdomain/path', 'title' => ''], + 'ClientId' => ['description' => 'The application ID registered with the OIDC or IDaaS service.', 'type' => 'string', 'example' => 'example-app', 'title' => ''], + 'ClientSecret' => ['description' => 'The application secret registered with the OIDC or IDaaS service.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], + 'CookieDomain' => ['description' => 'The cookie domain used to maintain the login session after successful OIDC or IDaaS authentication.', 'type' => 'string', 'example' => 'hello.com', 'title' => ''], + 'ScopesList' => [ + 'description' => 'The scopes of the OIDC authentication.', + 'items' => ['description' => '', 'type' => 'string', 'example' => 'openid', 'extendType' => 'true'], + 'type' => 'string', + 'example' => '["openid","email"]', + 'title' => '', + ], + 'LoginUrl' => ['description' => 'The URL of the user sign-in page for IDaaS authentication.', 'type' => 'string', 'example' => 'https://daxxxxcn.aliyunidaas.com/', 'title' => ''], + 'Sub' => ['description' => 'The subject (`sub`) of the JWT claims. This is returned when the authentication type is `JWT`.', 'type' => 'string', 'example' => 'https://example.com/auth', 'title' => ''], + 'ExternalAuthZ' => [ + 'title' => '', + 'description' => 'The details of the custom authentication.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The authentication service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '15300', 'title' => ''], + 'PrefixPath' => ['description' => 'The path of the authentication API.', 'type' => 'string', 'example' => '/auth', 'title' => ''], + 'TokenKey' => ['description' => 'The request header that contains the token, such as `Authorization` or `Cookie`.', 'type' => 'string', 'example' => 'Authorization', 'title' => ''], + 'AllowRequestHeaders' => [ + 'title' => '', + 'description' => 'The allowed request headers.', + 'type' => 'array', + 'items' => ['description' => 'The name of the allowed request header.', 'type' => 'string', 'example' => 'x-req', 'title' => ''], + 'example' => '', + ], + 'AllowUpstreamHeaders' => [ + 'title' => '', + 'description' => 'The allowed response headers.', + 'type' => 'array', + 'items' => ['description' => 'The name of the allowed response header.', 'type' => 'string', 'example' => 'x-resp', 'title' => ''], + 'example' => '', + ], + 'Timeout' => ['description' => 'The timeout for the authentication service, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'IsRestrict' => ['description' => 'The custom authentication mode.'."\n" + ."\n" + .'- `true`: strict mode. The gateway rejects client requests if the authentication service is unavailable (for example, due to a connection failure or a 5xx error).'."\n" + ."\n" + .'- `false`: loose mode. The gateway allows client requests to bypass authentication if the authentication service is unavailable.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Service' => [ + 'title' => '', + 'description' => 'Details of the authentication service.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the authentication service.', 'type' => 'string', 'example' => ' httpbin-auth-service', 'title' => ''], + 'SourceType' => ['description' => 'The source type of the authentication service.', 'type' => 'string', 'example' => 'K8s', 'title' => ''], + 'GroupName' => ['description' => 'The group to which the authentication service belongs.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the authentication service.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'example' => '', + ], + 'WithRequestBody' => ['description' => 'Specifies whether to forward the request body to the authentication service.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'BodyMaxBytes' => ['description' => 'The maximum size of the request body, in bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '4000000', 'title' => ''], + 'WithRematchRoute' => ['description' => 'Specifies whether to rematch the route after authentication.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'ResourceList' => [ + 'title' => '', + 'description' => 'A list of authorization rules. These rules are combined using a logical OR. Within each rule, all match conditions must be met (logical AND).', + 'type' => 'array', + 'items' => [ + 'description' => 'An authorization rule.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the authorization rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1303', 'title' => ''], + 'AuthId' => ['description' => 'The ID of the authentication to which this rule belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '2274', 'title' => ''], + 'DomainId' => ['description' => 'The ID of the domain name in the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765', 'title' => ''], + 'DomainName' => ['description' => 'The domain name in the rule.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Path' => ['description' => 'The path pattern of the rule.', 'type' => 'string', 'example' => '/test', 'title' => ''], + 'IsWhite' => ['description' => 'The authorization mode.'."\n" + ."\n" + .'- `true`: whitelist mode. Requests for the hosts and paths in the list can bypass authentication. All other requests require authentication.'."\n" + ."\n" + .'- `false`: blacklist mode. Requests for the hosts and paths in the list require authentication. All other requests can bypass authentication.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'GatewayId' => ['description' => 'The ID of the associated gateway.', 'type' => 'integer', 'format' => 'int64', 'example' => '2274', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the associated gateway.', 'type' => 'string', 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the authorization rule was created, in GMT.', 'type' => 'string', 'example' => '2024-02-19T03:32:38.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the authorization rule was last modified, in GMT.', 'type' => 'string', 'example' => '2024-02-19T03:32:38.000+0000', 'title' => ''], + 'MatchType' => ['description' => 'The match type for the request path. Valid values:'."\n" + ."\n" + .'- `EQUAL`: exact match'."\n" + ."\n" + .'- `PRE`: prefix match'."\n" + ."\n" + .'- `REGULAR`: regular expression match', 'type' => 'string', 'example' => 'EQUAL', 'title' => ''], + 'IgnoreCase' => ['description' => 'Specifies whether the path matching is case-sensitive.'."\n" + ."\n" + .'- `true`: Path matching is case-insensitive.'."\n" + ."\n" + .'- `false`: Path matching is case-sensitive.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AuthResourceHeaderList' => [ + 'title' => '', + 'description' => 'A list of match conditions based on request headers. This parameter applies only to custom authentication.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => ['description' => 'The name of the request header.', 'type' => 'string', 'example' => 'x-req', 'title' => ''], + 'HeaderMethod' => ['description' => 'The match condition. Valid values:'."\n" + ."\n" + .'- `EQUAL`: equals'."\n" + ."\n" + .'- `NOT_EQUAL`: does not equal'."\n" + ."\n" + .'- `EXIST`: exists'."\n" + ."\n" + .'- `NOT_EXIST`: does not exist'."\n" + ."\n" + .'- `INCLUDE`: contains'."\n" + ."\n" + .'- `EXCLUDE`: does not contain'."\n" + ."\n" + .'- `PREFIX`: starts with'."\n" + ."\n" + .'- `SUFFIX`: ends with'."\n" + ."\n" + .'- `REGEX`: matches a regular expression', 'type' => 'string', 'example' => 'EQUAL', 'title' => ''], + 'HeaderValue' => ['description' => 'The header value to match.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AuthResourceMode' => ['description' => 'The authorization resource mode. Valid values:'."\n" + ."\n" + .'- `0`: simple mode'."\n" + ."\n" + .'- `1`: complex mode', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'AuthResourceConfig' => ['description' => 'The YAML configuration for the complex mode.', 'type' => 'string', 'title' => '', 'example' => 'permissions:'."\n" + .' - not_rule:'."\n" + .' or_rules:'."\n" + .' rules:'."\n" + .' - and_rules:'."\n" + .' rules:'."\n" + .' - url_path:'."\n" + .' path:'."\n" + .' ignore_case: false'."\n" + .' prefix: /version'."\n" + .' - and_rules:'."\n" + .' rules:'."\n" + .' - url_path:'."\n" + .' path:'."\n" + .' ignore_case: false'."\n" + .' prefix: /header'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'BindSentinelBlockFallbackDefinition', - ], - 'ListIsolationRules' => [ - 'summary' => 'Queries isolation rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'msc', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1100,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-6f0dbd108a0249d2b675b3ef50b*****\\",\\n \\"GatewayId\\": 2274,\\n \\"Type\\": \\"JWT\\",\\n \\"Issuer\\": \\"https://example.com/auth\\",\\n \\"Jwks\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"keys\\\\\\\\\\\\\\":[\\\\\\\\n {\\\\\\\\n \\\\\\\\\\\\\\"kty\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"RSA\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"e\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"AQAB\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"use\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"sig\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"kid\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"alg\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"RS256\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"n\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n ]\\\\\\\\n}\\\\\\\\n\\",\\n \\"IsWhite\\": true,\\n \\"GmtCreate\\": \\"2024-02-19T02:41:03.000+0000\\",\\n \\"GmtModified\\": \\"2024-02-19T02:41:03.000+0000\\",\\n \\"TokenPosition\\": \\"HEADER\\",\\n \\"TokenName\\": \\"Authorization\\",\\n \\"TokenNamePrefix\\": \\"Bearer \\",\\n \\"TokenPass\\": true,\\n \\"Status\\": false,\\n \\"RedirectUrl\\": \\"https://yourdomain/path\\",\\n \\"ClientId\\": \\"example-app\\",\\n \\"ClientSecret\\": \\"xxxxx\\",\\n \\"CookieDomain\\": \\"hello.com\\",\\n \\"ScopesList\\": \\"[\\\\\\"openid\\\\\\",\\\\\\"email\\\\\\"]\\",\\n \\"LoginUrl\\": \\"https://daxxxxcn.aliyunidaas.com/\\",\\n \\"Sub\\": \\"https://example.com/auth\\",\\n \\"ExternalAuthZ\\": {\\n \\"ServiceId\\": 15300,\\n \\"PrefixPath\\": \\"/auth\\",\\n \\"TokenKey\\": \\"Authorization\\",\\n \\"AllowRequestHeaders\\": [\\n \\"x-req\\"\\n ],\\n \\"AllowUpstreamHeaders\\": [\\n \\"x-resp\\"\\n ],\\n \\"Timeout\\": 10,\\n \\"IsRestrict\\": true,\\n \\"Service\\": {\\n \\"Name\\": \\" httpbin-auth-service\\",\\n \\"SourceType\\": \\"K8s\\",\\n \\"GroupName\\": \\"test\\",\\n \\"Namespace\\": \\"default\\"\\n },\\n \\"WithRequestBody\\": true,\\n \\"BodyMaxBytes\\": 4000000,\\n \\"WithRematchRoute\\": false\\n },\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 1303,\\n \\"AuthId\\": 2274,\\n \\"DomainId\\": 1765,\\n \\"DomainName\\": \\"example.com\\",\\n \\"Path\\": \\"/test\\",\\n \\"IsWhite\\": true,\\n \\"GatewayId\\": 2274,\\n \\"GatewayUniqueId\\": \\"gw-6f0dbd108a0249d2b675b3ef50b*****\\",\\n \\"GmtCreate\\": \\"2024-02-19T03:32:38.000+0000\\",\\n \\"GmtModified\\": \\"2024-02-19T03:32:38.000+0000\\",\\n \\"MatchType\\": \\"EQUAL\\",\\n \\"IgnoreCase\\": true,\\n \\"AuthResourceHeaderList\\": [\\n {\\n \\"HeaderKey\\": \\"x-req\\",\\n \\"HeaderMethod\\": \\"EQUAL\\",\\n \\"HeaderValue\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"AuthResourceMode\\": 0,\\n \\"AuthResourceConfig\\": \\"permissions:\\\\n - not_rule:\\\\n or_rules:\\\\n rules:\\\\n - and_rules:\\\\n rules:\\\\n - url_path:\\\\n path:\\\\n ignore_case: false\\\\n prefix: /version\\\\n - and_rules:\\\\n rules:\\\\n - url_path:\\\\n path:\\\\n ignore_case: false\\\\n prefix: /header\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayAuthDetail', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayAuthDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'GetGatewayConfig' => [ + 'summary' => 'Retrieves the parameter configurations of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -19954,1472 +12871,1406 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '163572', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '141101', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-61f465fa2dd044069e2208c4912*****', 'title' => ''], ], [ - 'name' => 'ResourceSearchKey', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '查找包含接口关键字的防护规则。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese. en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - ], - [ - 'name' => 'Resource', - 'in' => 'query', - 'schema' => [ - 'title' => '查找指定接口的防护规则。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], - ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'title' => '起始页。默认值为1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小。默认值为6。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code. If the request was successful, a value of 200 is returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'DynamicCode' => ['description' => 'This parameter is unavailable for use. Ignore this parameter.', 'type' => 'string', 'title' => '', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'This parameter is unavailable for use. Ignore this parameter.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'title' => '规则信息。', - 'description' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'title' => '返回结果。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'RuleId' => [ - 'title' => '规则ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '', - 'type' => 'string', - 'example' => '/a', - ], - 'Threshold' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'RegionId' => [ - 'title' => '集群所在地域。', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'FallbackObject' => [ - 'title' => '规则绑定的行为。', - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', - ], - 'LimitApp' => [ - 'type' => 'string', - ], - ], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-61f465fa2dd044069e2208c4912*****', 'title' => ''], + 'EnableGenerateRequestId' => ['description' => 'Indicates whether request IDs are generated in request headers. Request IDs are used to trace requests. This parameter is used to determine the range of requests.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableGzip' => ['description' => 'Indicates whether GZIP compression is enabled. If GZIP compression is enabled, requests and responses are compressed. This reduces gateway traffic but increases the CPU load of the gateway. This parameter applies to requests and responses.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'EnableSlashMerge' => ['description' => 'Indicates whether multiple forward slashes (/) in requests are combined into one forward slash (/). This parameter applies to requests. For example, if this parameter is set to true, www\\.a.com//b is changed to www\\.a.com/b based on the combination of forward slashes (/).', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'DownstreamIdleTime' => ['description' => 'The timeout period of the connection from the client to the gateway. If no requests are available in the specified period of time, the gateway connection is closed. This parameter applies to gateway connections.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '180'], + 'PreserveHeaderFormat' => ['description' => 'Indicates whether all letters of a header are converted into lowercase letters. For requests and responses, HTTP/1.1 headers are not case-sensitive. By default, all letters of HTTP/1.1 headers are converted into lowercase letters to ensure the compatibility with HTTP/2 standards.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'DownstreamConnectionBufferLimits' => ['description' => 'The maximum buffer size of a gateway connection. Unit: bytes. This parameter has an impact on the throughput and the use of gateway memory. This parameter applies to gateway connections.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '32768'], + 'EnableHardwareAccelerate' => ['description' => 'Indicates whether hardware acceleration is enabled. If hardware acceleration is not supported in the region where your cloud-native gateway resides or hardware acceleration is not enabled when you purchase your cloud-native gateway, this parameter does not take effect.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'XffTrustedNum' => ['description' => 'The number of trusted proxies of the gateway. This parameter applies to requests and determines whether the gateway uses the request headers generated by the client. The request headers include x-forwarded-for and x-request-id.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'EnableHttp2' => ['description' => 'Indicates whether HTTP/2 connections are used between the server and the client. This parameter applies to requests. The new configuration takes effect 1 to 2 minutes after you modify the configuration.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'DownstreamHttp2MaxConcurrentStream' => ['description' => 'The maximum number of concurrent streams on an HTTP/2 connection. This parameter applies to requests.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'InitialStreamWindowSize' => ['description' => 'The initial window size of a stream on an HTTP/2 connection between the gateway and the client. Unit: bytes. This parameter applies to requests.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '65535'], + 'InitialConnectionWindowSize' => ['description' => 'The initial window size of an HTTP/2 connection between the gateway and the client. Unit: bytes. This parameter applies to requests.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1048576'], + 'XtraceDetails' => [ + 'description' => 'The information about tracing analysis.', + 'type' => 'object', + 'properties' => [ + 'TraceOn' => ['description' => 'Indicates whether tracing analysis is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The trace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '255', 'title' => ''], + 'Sample' => ['description' => 'The sampling rate of tracing analysis. Unit: percentage (%).', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-61f465fa2dd044069e2208c4912*****', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the information about tracing analysis was created.', 'type' => 'string', 'example' => '2024-08-12T09:39:07.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the information about tracing analysis was modified.', 'type' => 'string', 'example' => '2024-08-12T09:39:07.000+0000', 'title' => ''], + 'TraceType' => ['description' => 'The type of tracing analysis. Valid values:'."\n" + ."\n" + .'- XTRACE: Managed Service for OpenTelemetry with the Zipkin protocol is used.'."\n" + ."\n" + .'- SKYWALKING: Self-managed SkyWalking is used.'."\n" + ."\n" + .'- OPENTELEMETRY: Managed Service for OpenTelemetry with the OpenTelemetry protocol is used.'."\n" + ."\n" + .'- OTSKYWALKING: Managed Service for OpenTelemetry with the SkyWalking protocol is used.', 'type' => 'string', 'example' => 'OPENTELEMETRY', 'title' => ''], + 'ServiceId' => ['description' => 'The ID of the self-managed SkyWalking service.', 'type' => 'integer', 'format' => 'int64', 'example' => '333', 'title' => ''], + 'ServicePort' => ['description' => 'The port number of the self-managed SkyWalking service.', 'type' => 'string', 'example' => '8888', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'PageNumber' => [ - 'title' => '起始页。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'SlsConfigDetails' => [ + 'description' => 'The information about log shipping.', + 'type' => 'object', + 'properties' => [ + 'LogOn' => ['description' => 'Indicates whether log shipping is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'This parameter is unavailable for use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the project for which log shipping is enabled.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'LogStoreName' => ['description' => 'The name of the Logstore to which logs are shipped.'."\n" + ."\n" + .'- If the NginxCompatible parameter is set to false, the Logstore name is mse\\_gw\\_access\\_log.'."\n" + ."\n" + .'- If the NginxCompatible parameter is set to true, the Logstore name is nginx-ingress.', 'type' => 'string', 'example' => 'mse_gw_access_log', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-61f465fa2dd044069e2208c4912*****'."\n", 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], + 'GmtCreate' => ['description' => 'This parameter is unavailable for use.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'GmtModified' => ['description' => 'This parameter is unavailable for use.', 'type' => 'string', 'example' => ' ""', 'title' => ''], + 'NginxCompatible' => ['description' => 'Indicates whether Microservices Engine (MSE) Ingress gateways are compatible with NGINX Ingress gateways.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'PageSize' => [ - 'title' => '页大小。', + 'SupportWaf' => ['description' => 'Indicates whether Web Application Firewall (WAF) is supported for gateways.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableWaf' => ['description' => 'Indicates whether WAF is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessLogHeader' => ['description' => 'The custom log format.', 'type' => 'string', 'example' => '{"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}', 'title' => ''], + 'EnableHttp3' => ['description' => 'Indicates whether the HTTP/3 protocol is supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'UpstreamIdleTimeout' => ['description' => 'The default timeout period for a connection between a gateway and an upstream system. If the idle period of the connection to an upstream system exceeds the value of this parameter, the connection is closed.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'ZipAlgorithm' => ['description' => 'The compression algorithm. Valid values: brotli and gzip. If you specify this parameter and you do not set EnableGzip to true, the value of EnableGzip is automatically changed to true.', 'type' => 'string', 'example' => '["gzip"]', 'title' => ''], + 'PathWithEscapedSlashes' => ['description' => 'The forwarding policy of the request whose Uniform Resource Identifier (URI) contains escaped characters, such as %2F, %2f, %5C, or %5c. Default value: KEEP\\_UNCHANGED. We recommend that you use the default value.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- KEEP\\_UNCHANGED'."\n" + ."\n" + .'- REJECT\\_REQUEST'."\n" + ."\n" + .'- UNESCAPE\\_AND\\_REDIRECT'."\n" + ."\n" + .'- UNESCAPE\\_AND\\_FORWARD', 'type' => 'string', 'example' => 'KEEP_UNCHANGED', 'title' => ''], + 'NoSupportedConfigList' => ['description' => 'The configurations that are not supported.', 'type' => 'string', 'example' => '"EnableProxyProtocol,EnableCustomAuthConfigPush"', 'title' => ''], + 'LogFilterConfig' => ['description' => 'This parameter is unavailable for use.', 'type' => 'string', 'example' => ' ""', 'title' => ''], + 'EnableProxyProtocol' => ['description' => 'Indicates whether the proxy protocol is enabled. If a Network Load Balancer (NLB) instance is used as a traffic ingress, the real IP address of the client cannot be obtained if you do not enable the proxy protocol. After you enable the proxy protocol, requests that do not comply with the proxy protocol remain unaffected.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableCustomAuthConfigPush' => ['description' => 'Indicates whether the connection is closed if custom authentication rules change. The value true indicates that the connection is not closed. This parameter is suitable for scenarios in which custom authentication services are available and WebSocket and online business are used.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'KeepaliveHeaderTimeout' => ['description' => 'The connection timeout period contained in the keep-alive response header that is returned to the client. For example, if you set this parameter to 10, the response header `keep-alive: timeout=10` is returned. If you set this parameter to 0, the response header is not returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WebsocketTermGracePeriod' => ['description' => 'The keep-alive time that is maintained for the WebSocket connection in scenarios where the connection needs to be closed, such as gateway upgrade or restart. Unit: seconds.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '30'], + 'EnableK8sSourceWorkloadFilter' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'LabelKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'LabelValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FilterOpt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'title' => '', + 'example' => '', ], - 'TotalSize' => [ - 'title' => '规则总数。', + 'EnableXffTrustedCidrs' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'IpListContent' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'title' => '', + 'example' => '', ], + 'EnableGzipHardwareAccelerate' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6092602-C357-4750-89D9-E572FBEA****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\",\\n \\"EnableGenerateRequestId\\": true,\\n \\"EnableGzip\\": false,\\n \\"EnableSlashMerge\\": true,\\n \\"DownstreamIdleTime\\": 180,\\n \\"PreserveHeaderFormat\\": true,\\n \\"DownstreamConnectionBufferLimits\\": 32768,\\n \\"EnableHardwareAccelerate\\": true,\\n \\"XffTrustedNum\\": 0,\\n \\"EnableHttp2\\": false,\\n \\"DownstreamHttp2MaxConcurrentStream\\": 100,\\n \\"InitialStreamWindowSize\\": 65535,\\n \\"InitialConnectionWindowSize\\": 1048576,\\n \\"XtraceDetails\\": {\\n \\"TraceOn\\": true,\\n \\"Id\\": 255,\\n \\"Sample\\": 100,\\n \\"GatewayId\\": 500,\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\",\\n \\"GmtCreate\\": \\"2024-08-12T09:39:07.000+0000\\",\\n \\"GmtModified\\": \\"2024-08-12T09:39:07.000+0000\\",\\n \\"TraceType\\": \\"OPENTELEMETRY\\",\\n \\"ServiceId\\": 333,\\n \\"ServicePort\\": \\"8888\\"\\n },\\n \\"SlsConfigDetails\\": {\\n \\"LogOn\\": true,\\n \\"Id\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"LogStoreName\\": \\"mse_gw_access_log\\",\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\\\n\\",\\n \\"GatewayId\\": 500,\\n \\"GmtCreate\\": \\"\\\\\\"\\\\\\"\\",\\n \\"GmtModified\\": \\" \\\\\\"\\\\\\"\\",\\n \\"NginxCompatible\\": false\\n },\\n \\"SupportWaf\\": true,\\n \\"EnableWaf\\": true,\\n \\"AccessLogHeader\\": \\"{\\\\\\"requestMetadata\\\\\\":[],\\\\\\"responseHeaders\\\\\\":[],\\\\\\"requestHeaders\\\\\\":[\\\\\\"x-test\\\\\\"],\\\\\\"responseMetadata\\\\\\":[]}\\",\\n \\"EnableHttp3\\": false,\\n \\"UpstreamIdleTimeout\\": 30,\\n \\"ZipAlgorithm\\": \\"[\\\\\\"gzip\\\\\\"]\\",\\n \\"PathWithEscapedSlashes\\": \\"KEEP_UNCHANGED\\",\\n \\"NoSupportedConfigList\\": \\"\\\\\\"EnableProxyProtocol,EnableCustomAuthConfigPush\\\\\\"\\",\\n \\"LogFilterConfig\\": \\" \\\\\\"\\\\\\"\\",\\n \\"EnableProxyProtocol\\": true,\\n \\"EnableCustomAuthConfigPush\\": \\"false\\",\\n \\"KeepaliveHeaderTimeout\\": 0,\\n \\"WebsocketTermGracePeriod\\": 30,\\n \\"EnableK8sSourceWorkloadFilter\\": {\\n \\"Enable\\": false,\\n \\"LabelKey\\": \\"\\",\\n \\"LabelValue\\": \\"\\",\\n \\"FilterOpt\\": \\"\\"\\n },\\n \\"EnableXffTrustedCidrs\\": {\\n \\"Enable\\": false,\\n \\"IpListContent\\": \\"\\"\\n },\\n \\"EnableGzipHardwareAccelerate\\": false\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayConfig', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 3\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListIsolationRules', ], - 'CreateIsolationRule' => [ - 'summary' => 'Creates an isolation rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGatewayDomainDetail' => [ + 'summary' => 'Queries the details of a domain name associated with a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '163570', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '35699', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'docRequired' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'Resource', - 'in' => 'query', - 'schema' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/a', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '应用所在地域。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the domain name.', 'type' => 'string', 'required' => false, 'example' => '29', 'title' => ''], ], [ - 'name' => 'LimitApp', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-6d0b23e1d39e41658a968d79a635****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Code' => [ - 'title' => '响应码。', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '88B83302-CD88-54D3-8DF2-208BFDC73F0D'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '403', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '规则信息。', - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '', - 'type' => 'string', - 'example' => '/a', - ], - 'Threshold' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '3', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'hpn9ac29kz@e31a4b871******', - ], - 'RegionId' => [ - 'title' => '集群所在地域。', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LimitApp' => [ - 'type' => 'string', - ], + 'Id' => ['description' => 'The ID of the domain name.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Name' => ['description' => 'The name of the domain.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Protocol' => ['description' => 'The gateway protocol.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'MustHttps' => ['description' => 'Specifies whether to enforce HTTPS.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CertIdentifier' => ['description' => 'The certificate identifier.', 'type' => 'string', 'example' => '234-cn-hangzhou', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the domain name was created.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the domain name was last modified.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'CertName' => ['description' => 'The name of the certificate.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CommonName' => ['description' => 'The public domain name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Sans' => ['description' => 'The name of the extension field.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'BeforeDate' => ['description' => 'The time when the certificate was issued.', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-04-01 02:35:12', 'title' => ''], + 'AfterDate' => ['description' => 'The time when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-04-01 02:35:12', 'title' => ''], + 'Algorithm' => ['description' => 'The algorithm.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'Issuer' => ['description' => 'The issuer.', 'type' => 'string', 'example' => 'Istio', 'title' => ''], + 'GmtBefore' => ['description' => 'The time when the certificate was issued. The time is in GMT.', 'type' => 'string', 'example' => '2021-04-01 02:35:12', 'title' => ''], + 'GmtAfter' => ['description' => 'The time when the certificate expires. The time is in GMT.', 'type' => 'string', 'example' => '2021-04-01 02:35:12', 'title' => ''], + 'Http2' => ['description' => 'Specifies whether `HTTP/2` is enabled. Valid values:'."\n" + ."\n" + .'- `open`: HTTP/2 is enabled.'."\n" + ."\n" + .'- `close`: HTTP/2 is disabled.'."\n" + ."\n" + .'- `globalConfig`: The global configuration is used.', 'type' => 'string', 'example' => 'close', 'title' => ''], + 'TlsMax' => ['description' => 'The maximum Transport Layer Security (TLS) version.', 'type' => 'string', 'example' => 'TLS 1.3', 'title' => ''], + 'TlsMin' => ['description' => 'The minimum TLS version.', 'type' => 'string', 'example' => 'TLS 1.0', 'title' => ''], + 'IsManaged' => ['description' => 'Indicates whether the domain name is managed.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88B83302-CD88-54D3-8DF2-208BFDC73F0D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 403,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test.com\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 1,\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"234-cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"CertName\\": \\"test\\",\\n \\"CommonName\\": \\"name\\",\\n \\"Sans\\": \\"test.com\\",\\n \\"BeforeDate\\": 0,\\n \\"AfterDate\\": 0,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"Issuer\\": \\"Istio\\",\\n \\"GmtBefore\\": \\"2021-04-01 02:35:12\\",\\n \\"GmtAfter\\": \\"2021-04-01 02:35:12\\",\\n \\"Http2\\": \\"close\\",\\n \\"TlsMax\\": \\"TLS 1.3\\",\\n \\"TlsMin\\": \\"TLS 1.0\\",\\n \\"IsManaged\\": false\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayDomainDetail', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayDomainDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hpn9ac29kz@e31a4b871******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateIsolationRule', ], - 'DeleteIsolationRules' => [ - 'summary' => 'Deletes isolation rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGatewayOption' => [ + 'summary' => 'Obtains the global parameters of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '163574', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '92787', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'Ids', + 'name' => 'GatewayId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '待删除的规则ID列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '429', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '返回码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP状态码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '完成删除的规则ID列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C92F4A4D-A2FD-593E-839E-F3D4DFD2****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned. The value 200 indicates that the request is successfully processed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The detailed configurations of the gateway.'."\n" + ."\n" + .'* **TraceDetails**: the sampling description of Managed Service for OpenTelemetry. Content: TraceEnabled indicates whether Managed Service for OpenTelemetry is activated. Sample indicates the sampling rate of Managed Service for OpenTelemetry.'."\n" + .'* **LogConfigDetails**: the description of Simple Log Service. Content: LogEnabled indicates whether Simple Log Service is activated. ProjectName indicates the Simple Log Service project to which logs are delivered. LogStoreName indicates the name of the Logstore.'."\n" + .'* **EnableHardwareAcceleration**: indicates whether hardware acceleration is enabled.'."\n" + .'* **DisableHttp2Alpn**: indicates whether the HTTP/2 protocol is disabled.'."\n" + .'* **EnableWaf**: indicates whether Web Application Firewall (WAF) is enabled.'."\n", 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': False}, \'TraceDetails\': {\'TraceEnabled\': False}}', '$ref' => '#/components/schemas/GatewayOption', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C92F4A4D-A2FD-593E-839E-F3D4DFD2****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TraceDetails\\": {\\n \\"TraceEnabled\\": true,\\n \\"Sample\\": 10,\\n \\"TraceType\\": \\"XTRACE\\",\\n \\"ServiceId\\": 10458,\\n \\"ServicePort\\": \\"80\\"\\n },\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"project\\",\\n \\"LogStoreName\\": \\"name\\"\\n },\\n \\"EnableHardwareAcceleration\\": true,\\n \\"DisableHttp2Alpn\\": true,\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayOption', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayOption', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', - 'title' => 'DeleteIsolationRules', ], - 'UpdateIsolationRule' => [ - 'summary' => 'Updates an isolation rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGatewayRouteDetail' => [ + 'summary' => 'Queries the details of a gateway route.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '163571', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'title' => '规则ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'docRequired' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AppId', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['description' => 'Route ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '1050', 'title' => ''], ], [ - 'name' => 'LimitApp', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Gateway unique identifier ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-5d3a78a53ec947aa928212d671d400ac', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Code' => [ - 'title' => '响应码。', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FDF2D16C-5D28-5FAA-A56B-30BDE3559880'], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'Status code. Note that 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Request result, with the following values:'."\n" + ."\n" + .'- `true`: The request is successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '规则信息。', - 'description' => '', + 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '', - 'type' => 'string', - 'example' => '/a', + 'Id' => ['description' => 'ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1050', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'Gateway unique identifier ID.', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****', 'title' => ''], + 'GatewayId' => ['description' => 'Gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DefaultServiceId' => ['description' => 'Default service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'DefaultServiceName' => ['description' => 'Default service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Status' => ['description' => 'Route status.'."\n" + ."\n" + .'- Not published: 0'."\n" + ."\n" + .'- Publishing: 2'."\n" + ."\n" + .'- Published: 3'."\n" + ."\n" + .'- Editing (updates not published): 4'."\n" + ."\n" + .'- Unpublishing: 5'."\n" + ."\n" + .'- Unavailable: 6', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'Last modification time.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'RouteOrder' => ['description' => 'Route order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Predicates' => ['description' => 'Matching conditions.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'RoutePredicates' => [ + 'description' => 'Route matching.', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'Route matching.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'Path.', 'type' => 'string', 'example' => '/api', 'title' => ''], + 'Type' => ['description' => 'Matching type.', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + 'IgnoreCase' => ['description' => 'Whether to ignore case.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'MethodPredicates' => [ + 'description' => 'Method matching.', + 'type' => 'array', + 'items' => ['description' => 'Method.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'HeaderPredicates' => [ + 'description' => 'Header matching.', + 'type' => 'array', + 'items' => [ + 'description' => 'Request header.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Request header KEY.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'Value' => ['description' => 'Matching value.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Type' => ['description' => 'Type.', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'QueryPredicates' => [ + 'description' => 'Parameter matching.', + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Parameter name.', 'type' => 'string', 'example' => 'userid', 'title' => ''], + 'Value' => ['description' => 'Matching value.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'Type.', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'Threshold' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '3', + 'DomainId' => ['description' => 'Domain ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '235', 'title' => ''], + 'DomainName' => ['description' => 'Domain name.', 'type' => 'string', 'example' => '123.com', 'title' => ''], + 'Services' => ['description' => 'Service configuration information.', 'type' => 'string', 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', 'title' => ''], + 'RouteServices' => [ + 'description' => 'Services.', + 'type' => 'array', + 'items' => [ + 'description' => 'Service.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '782', 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'xkc-crm', 'title' => ''], + 'Percent' => ['description' => 'Weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'Version' => ['description' => 'Service version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'dubbo4', 'title' => ''], + 'SourceType' => ['description' => 'Service source.', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'GroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => 'api', 'title' => ''], + 'AgreementType' => ['description' => 'Protocol Type.', 'type' => 'string', 'example' => 'DUBBO', 'title' => ''], + 'HttpDubboTranscoder' => [ + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'Dubbo service name.', 'type' => 'string', 'example' => 'org.apache.dubbo.samples.basic.api.DemoService'."\n", 'title' => ''], + 'DubboServiceVersion' => ['description' => 'Dubbo service version.', 'type' => 'string', 'example' => '0.0.0', 'title' => ''], + 'MothedMapList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'Dubbo method name.', 'type' => 'string', 'example' => 'sayHello', 'title' => ''], + 'HttpMothed' => ['description' => 'Http method.'."\n" + ."\n" + .'> Supported http method parameter values.'."\n" + .'>'."\n" + .'> - ALL\\_GET'."\n" + .'>'."\n" + .'> - ALL\\_POST'."\n" + .'>'."\n" + .'> - ALL\\_PUT'."\n" + .'>'."\n" + .'> - ALL\\_DELETE'."\n" + .'>'."\n" + .'> - ALL\\_PATCH', 'type' => 'string', 'example' => 'ALL_GET', 'title' => ''], + 'Mothedpath' => ['description' => 'Method matching path.', 'type' => 'string', 'example' => '/mytestzbk/sayhello', 'title' => ''], + 'PassThroughAllHeaders' => ['description' => 'Header pass-through type.'."\n" + ."\n" + .'> Pass-through type enumeration values.'."\n" + .'>'."\n" + .'> - Pass through all: PASS\\_ALL'."\n" + .'>'."\n" + .'> - No pass-through: PASS\\_NOT'."\n" + .'>'."\n" + .'> - Specified parameters: PASS\\_ASSIGN', 'type' => 'string', 'example' => 'PASS_NOT', 'title' => ''], + 'PassThroughList' => [ + 'type' => 'array', + 'items' => ['description' => 'Specified Header pass-through value.', 'type' => 'string', 'example' => 'x-forward', 'title' => ''], + 'description' => 'Specified Header pass-through list.', + 'title' => '', + 'example' => '', + ], + 'ParamMapsList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => 'Input parameter position.'."\n" + ."\n" + .'> Input parameter position enumeration values.'."\n" + .'>'."\n" + .'> - Request parameter: `ALL_QUERY_PARAMETER`'."\n" + .'>'."\n" + .'> - Request header: `ALL_HEADER`'."\n" + .'>'."\n" + .'> - URI of the request: `ALL_PATH`'."\n" + .'>'."\n" + .'> - Request body: `ALL_BODY`', 'type' => 'string', 'example' => 'ALL_QUERY_PARAMETER', 'title' => ''], + 'ExtractKey' => ['description' => 'Input parameter extraction Key.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'MappingType' => ['description' => 'Backend parameter type.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'Parameter mapping list.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'Dubbo forwarding rule list.', + 'title' => '', + 'example' => '', + ], + 'DubboServiceGroup' => ['description' => 'Dubbo service group.', 'type' => 'string', 'example' => 'service group', 'title' => ''], + ], + 'description' => 'Dubbo protocol conversion body.', + 'title' => '', + 'example' => '', + ], + 'ServicePort' => ['description' => 'Service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '20880', 'title' => ''], + 'HealthStatus' => ['description' => 'Health status'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', 'type' => 'string', 'example' => 'Health', 'title' => ''], + 'UnhealthyEndpoints' => [ + 'type' => 'array', + 'items' => ['description' => 'Unhealthy Endpoint', 'type' => 'string', 'example' => '192.168.1.2', 'title' => ''], + 'description' => 'Unhealthy Endpoint list', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'HTTPRewrite' => [ + 'description' => 'Rewrite policy information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Enabling status.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'Path' => ['description' => 'Node path.', 'type' => 'string', 'example' => '/test/client', 'title' => ''], + 'Host' => ['description' => 'Instance address.', 'type' => 'string', 'example' => 'aliyuncs.com', 'title' => ''], + 'PathType' => ['description' => 'Rewrite type.', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + 'Pattern' => ['description' => 'Matching Pattern.', 'type' => 'string', 'example' => '/test', 'title' => ''], + 'Substitution' => ['description' => 'Replacement.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', + 'HeaderOp' => [ + 'description' => 'Header settings information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Status.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'HeaderOpItems' => [ + 'description' => 'Header field objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'Setting policy.', + 'type' => 'object', + 'properties' => [ + 'DirectionType' => ['description' => 'Request or response.', 'type' => 'string', 'example' => 'Response', 'title' => ''], + 'OpType' => ['description' => 'Operation type.', 'type' => 'string', 'example' => 'Add', 'title' => ''], + 'Key' => ['description' => 'Header Key.', 'type' => 'string', 'example' => 'debug', 'title' => ''], + 'Value' => ['description' => 'Setting value.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'LimitApp' => [ - 'type' => 'string', + 'DestinationType' => ['description' => 'Target service type.', 'type' => 'string', 'example' => 'Single', 'title' => ''], + 'DirectResponse' => [ + 'description' => 'Mock information.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Body' => ['description' => 'Mock return value.', 'type' => 'string', 'example' => '{}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Cors' => [ + 'description' => 'Cross-domain configuration.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Status.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'AllowOrigins' => ['description' => 'Cross-domain.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'AllowMethods' => ['description' => 'Cross-domain methods.', 'type' => 'string', 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', 'title' => ''], + 'AllowHeaders' => ['description' => 'Cross-domain Header.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'ExposeHeaders' => ['description' => 'Response header.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'TimeUnit' => ['description' => 'Time unit.', 'type' => 'string', 'example' => 'h', 'title' => ''], + 'UnitNum' => ['description' => 'Time number.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''], + 'AllowCredentials' => ['description' => 'Allow credentials.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Timeout' => [ + 'description' => 'Timeout configuration.', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['description' => 'Unit number.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TimeUnit' => ['description' => 'Time unit.', 'type' => 'string', 'example' => 's', 'title' => ''], + 'Status' => ['description' => 'Status.', 'type' => 'string', 'example' => 'off', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Retry' => [ + 'description' => 'Retry configuration.', + 'type' => 'object', + 'properties' => [ + 'Attempts' => ['description' => 'Number of retry attempts.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RetryOn' => [ + 'description' => 'Retry conditions.', + 'type' => 'array', + 'items' => ['description' => 'Retry condition.', 'type' => 'string', 'example' => '5xx', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'HttpCodes' => [ + 'description' => 'HTTP status codes.', + 'type' => 'array', + 'items' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '500', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'Retry status.', 'type' => 'string', 'example' => 'on', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DomainIdList' => [ + 'description' => 'Domain list', + 'type' => 'array', + 'items' => ['description' => 'Domain ID list.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DomainNameList' => [ + 'description' => 'Domain name list', + 'type' => 'array', + 'items' => ['description' => 'Domain name list.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Redirect' => [ + 'description' => 'Redirection configuration', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Host' => ['description' => 'Host.', 'type' => 'string', 'example' => '16', 'title' => ''], + 'Path' => ['description' => 'Path.', 'type' => 'string', 'example' => '10111', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FlowMirror' => [ + 'description' => 'Traffic mirroring configuration.', + 'type' => 'object', + 'properties' => [ + 'TargetServiceId' => ['description' => 'Target service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21', 'title' => ''], + 'TargetServiceName' => ['description' => 'Target service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Port' => ['description' => 'Target service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '8790', 'title' => ''], + 'Percentage' => ['description' => 'Traffic replication percentage (%), value range 0-100.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''], + 'Status' => ['description' => 'Enabling status, values:'."\n" + ."\n" + .'- on: enabled'."\n" + ."\n" + .'- off: disabled', 'type' => 'string', 'example' => 'on', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EnableWaf' => ['description' => 'Whether to enable Waf.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AhasStatus' => ['description' => 'Ahas status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Fallback' => ['description' => 'Whether to enable Fallback service.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FallbackServices' => [ + 'description' => 'Fallback services.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data object.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Percent' => ['description' => 'Weight percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'Version' => ['description' => 'Service version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'SourceType' => ['description' => 'Source type.', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'Service namespace.', 'type' => 'string', 'example' => 'namespace', 'title' => ''], + 'GroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AgreementType' => ['description' => 'Protocol Type.', 'type' => 'string', 'example' => 'DUBBO', 'title' => ''], + 'ServicePort' => ['description' => 'Service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '8848', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Policies' => ['description' => 'Routing policy Json string.', 'type' => 'string', 'example' => '{'."\n" + .' "CORS": "{\\"allowMethods\\":\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\"allowHeaders\\":\\"*\\",\\"exposeHeaders\\":\\"*\\",\\"unitNum\\":12,\\"allowCredentials\\":true,\\"status\\":\\"off\\",\\"allowOrigins\\":\\"*\\",\\"timeUnit\\":\\"h\\"}",'."\n" + .' "Timeout": "{\\"unitNum\\":10,\\"timeUnit\\":\\"s\\",\\"status\\":\\"off\\"}",'."\n" + .' "Retry": "{\\"attempts\\":2,\\"retryOn\\":[\\"5xx\\"],\\"status\\":\\"off\\"}",'."\n" + .' "HTTPRewrite": "{\\"pathType\\":\\"EQUAL\\",\\"path\\":\\"/o\\",\\"status\\":\\"off\\"}",'."\n" + .' "Waf": "{\\"enabled\\":false}",'."\n" + .' "HeaderOp": "{\\"status\\":\\"off\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Add\\",\\"key\\":\\"kkk\\",\\"value\\":\\"ll\\"}]}"'."\n" + .'}', 'title' => ''], + 'Description' => ['description' => 'Route description', 'type' => 'string', 'example' => 'a route for xxx', 'title' => ''], ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FDF2D16C-5D28-5FAA-A56B-30BDE3559880\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1050,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"DefaultServiceId\\": 3,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"Status\\": 0,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"RouteOrder\\": 1,\\n \\"Predicates\\": \\"{}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/api\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"200\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"123.com\\",\\n \\"Services\\": \\"[{\\\\\\\\\\\\\\"Percent\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"ServiceId\\\\\\\\\\\\\\":126}]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 782,\\n \\"ServiceName\\": \\"xkc-crm\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"dubbo4\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"GroupName\\": \\"api\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"HttpDubboTranscoder\\": {\\n \\"DubboServiceName\\": \\"org.apache.dubbo.samples.basic.api.DemoService\\\\n\\",\\n \\"DubboServiceVersion\\": \\"0.0.0\\",\\n \\"MothedMapList\\": [\\n {\\n \\"DubboMothedName\\": \\"sayHello\\",\\n \\"HttpMothed\\": \\"ALL_GET\\",\\n \\"Mothedpath\\": \\"/mytestzbk/sayhello\\",\\n \\"PassThroughAllHeaders\\": \\"PASS_NOT\\",\\n \\"PassThroughList\\": [\\n \\"x-forward\\"\\n ],\\n \\"ParamMapsList\\": [\\n {\\n \\"ExtractKeySpec\\": \\"ALL_QUERY_PARAMETER\\",\\n \\"ExtractKey\\": \\"name\\",\\n \\"MappingType\\": \\"java.lang.String\\"\\n }\\n ]\\n }\\n ],\\n \\"DubboServiceGroup\\": \\"service group\\"\\n },\\n \\"ServicePort\\": 20880,\\n \\"HealthStatus\\": \\"Health\\",\\n \\"UnhealthyEndpoints\\": [\\n \\"192.168.1.2\\"\\n ]\\n }\\n ],\\n \\"HTTPRewrite\\": {\\n \\"Status\\": \\"off\\",\\n \\"Path\\": \\"/test/client\\",\\n \\"Host\\": \\"aliyuncs.com\\",\\n \\"PathType\\": \\"PRE\\",\\n \\"Pattern\\": \\"/test\\",\\n \\"Substitution\\": \\"test\\"\\n },\\n \\"HeaderOp\\": {\\n \\"Status\\": \\"off\\",\\n \\"HeaderOpItems\\": [\\n {\\n \\"DirectionType\\": \\"Response\\",\\n \\"OpType\\": \\"Add\\",\\n \\"Key\\": \\"debug\\",\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n },\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"{}\\"\\n },\\n \\"Cors\\": {\\n \\"Status\\": \\"off\\",\\n \\"AllowOrigins\\": \\"*\\",\\n \\"AllowMethods\\": \\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\n \\"AllowHeaders\\": \\"*\\",\\n \\"ExposeHeaders\\": \\"*\\",\\n \\"TimeUnit\\": \\"h\\",\\n \\"UnitNum\\": 24,\\n \\"AllowCredentials\\": true\\n },\\n \\"Timeout\\": {\\n \\"UnitNum\\": 10,\\n \\"TimeUnit\\": \\"s\\",\\n \\"Status\\": \\"off\\"\\n },\\n \\"Retry\\": {\\n \\"Attempts\\": 1,\\n \\"RetryOn\\": [\\n \\"5xx\\"\\n ],\\n \\"HttpCodes\\": [\\n \\"500\\"\\n ],\\n \\"Status\\": \\"on\\"\\n },\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"16\\",\\n \\"Path\\": \\"10111\\"\\n },\\n \\"FlowMirror\\": {\\n \\"TargetServiceId\\": 21,\\n \\"TargetServiceName\\": \\"test\\",\\n \\"Port\\": 8790,\\n \\"Percentage\\": 90,\\n \\"Status\\": \\"on\\"\\n },\\n \\"EnableWaf\\": true,\\n \\"AhasStatus\\": 1,\\n \\"Fallback\\": true,\\n \\"FallbackServices\\": [\\n {\\n \\"ServiceId\\": 1,\\n \\"ServiceName\\": \\"name\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"name\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"GroupName\\": \\"test\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"ServicePort\\": 8848\\n }\\n ],\\n \\"Policies\\": \\"{\\\\n \\\\\\"CORS\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"allowMethods\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"allowHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"exposeHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"unitNum\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"allowCredentials\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"allowOrigins\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Timeout\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"unitNum\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"timeUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"s\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Retry\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"attempts\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"retryOn\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"5xx\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"HTTPRewrite\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"pathType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EQUAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/o\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Waf\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\":false}\\\\\\",\\\\n \\\\\\"HeaderOp\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"headerOpItems\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"directionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Request\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"opType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Add\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kkk\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ll\\\\\\\\\\\\\\"}]}\\\\\\"\\\\n}\\",\\n \\"Description\\": \\"a route for xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayRouteDetail', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayRouteDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"LimitApp\\": \\"\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateIsolationRule', ], - 'DeleteCircuitBreakerRules' => [ - 'summary' => 'Deletes circuit breaking rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGatewayServiceDetail' => [ + 'summary' => 'Queries the details of a service.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '167824', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '39518', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'Ids', + 'name' => 'ServiceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '待删除的规则ID列表。', - 'description' => 'The IDs of the rules that you want to delete.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the service.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '35', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-f4c960ad071a48a790b36324394c****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- `zh`: Chinese'."\n" + ."\n" + .'- `en`: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9802C54E-5CC5-5706-927B-993DBB6DCF2F'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Specifies whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '完成删除的规则ID列表。', - 'description' => 'The IDs of the rules that were deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => 'The ID of the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SourceType' => ['description' => 'The service source.', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'GroupName' => ['description' => 'The group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SourceId' => ['description' => 'The source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServiceNameInRegistry' => ['description' => 'The name of the service in the service registry.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MetaInfo' => ['description' => 'Basic information about the service.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Ips' => [ + 'description' => 'The IP addresses of the service instances.', + 'type' => 'array', + 'items' => ['description' => 'An IP address of a service instance.', 'type' => 'string', 'example' => '127.0.1.12', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Versions' => [ + 'description' => 'The service version. This parameter is deprecated.', + 'type' => 'array', + 'items' => [ + 'description' => 'A service version object.', + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'version', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LabelDetails' => [ + 'description' => 'The tag details.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag details object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'label', 'title' => ''], + 'Values' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'A tag value.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'VersionDetails' => [ + 'description' => 'Details of service versions.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details for a single service version.', + 'type' => 'object', + 'properties' => [ + 'ServiceVersion' => [ + 'description' => 'The details of the service version.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'v2', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'version', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'v2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'EndpointNum' => ['description' => 'The number of instances for this version.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EndpointNumPercent' => ['description' => 'The percentage of total instances that belong to this version.', 'type' => 'string', 'example' => '20%', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GmtCreate' => ['description' => 'The time when the service was created.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the service was last modified, in ISO 8601 format.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GatewayTrafficPolicy' => ['description' => 'The traffic policy for the service.', '$ref' => '#/components/schemas/TrafficPolicy', 'example' => '{}', 'title' => ''], + 'HealthStatus' => ['description' => 'The health status of the service.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'HealthCheck' => ['description' => 'Specifies whether the health check is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ServiceProtocol' => ['description' => 'The service protocol.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'Ports' => [ + 'description' => 'The service ports.', + 'type' => 'array', + 'items' => ['description' => 'A service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PortTrafficPolicyList' => [ + 'description' => 'The traffic policy of the service ports.', + 'type' => 'array', + 'items' => [ + 'description' => 'A traffic policy object for a port.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The port configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServicePort' => ['description' => 'The service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-2837hfd91h34dbg87364g*****', 'title' => ''], + 'TrafficPolicy' => ['description' => 'The traffic policy.', '$ref' => '#/components/schemas/TrafficPolicy', 'title' => '', 'example' => ''], + 'GmtCreate' => ['description' => 'The time when the policy was created, represented as a Unix timestamp in milliseconds.', 'type' => 'string', 'example' => '1667460287386', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the policy was last modified, represented as a Unix timestamp in milliseconds.', 'type' => 'string', 'example' => '1667460287386', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ServiceFQDN' => ['description' => 'The fully qualified domain name (FQDN) of the service.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ServicePort' => ['description' => 'The service port.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'DnsServerList' => [ + 'type' => 'array', + 'items' => ['description' => 'The address of a DNS server in the `IP address:Port` format.', 'type' => 'string', 'example' => '1.1.1.1:80', 'title' => ''], + 'description' => 'The list of DNS servers. This parameter applies only to services that use DNS for service discovery.', + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9802C54E-5CC5-5706-927B-993DBB6DCF2F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Succ\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": 1,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.1.12\\"\\n ],\\n \\"Versions\\": [\\n {\\n \\"Label\\": \\"version\\",\\n \\"Value\\": \\"v1\\",\\n \\"Type\\": \\"test\\"\\n }\\n ],\\n \\"LabelDetails\\": [\\n {\\n \\"Key\\": \\"label\\",\\n \\"Values\\": [\\n \\"v1\\"\\n ]\\n }\\n ],\\n \\"VersionDetails\\": [\\n {\\n \\"ServiceVersion\\": {\\n \\"Name\\": \\"v2\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"version\\",\\n \\"Value\\": \\"v2\\"\\n }\\n ]\\n },\\n \\"EndpointNum\\": 1,\\n \\"EndpointNumPercent\\": \\"20%\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GatewayTrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"6456988-cn-hangzhou\\",\\n \\"CaCertContent\\": \\"-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----\\",\\n \\"Sni\\": \\"www.aliyun.com\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"test\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"test\\",\\n \\"Path\\": \\"/path\\",\\n \\"TTL\\": \\"10s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"QUERY_PARAMETER\\"\\n },\\n \\"WarmupDuration\\": 5\\n }\\n },\\n \\"HealthStatus\\": \\"true\\",\\n \\"HealthCheck\\": \\"true\\",\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"Ports\\": [\\n 80\\n ],\\n \\"PortTrafficPolicyList\\": [\\n {\\n \\"Id\\": 1,\\n \\"ServiceId\\": 1,\\n \\"ServicePort\\": 8080,\\n \\"GatewayUniqueId\\": \\"gw-2837hfd91h34dbg87364g*****\\",\\n \\"TrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"6456988-cn-hangzhou\\",\\n \\"CaCertContent\\": \\"-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----\\",\\n \\"Sni\\": \\"www.aliyun.com\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"test\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"test\\",\\n \\"Path\\": \\"/path\\",\\n \\"TTL\\": \\"10s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"QUERY_PARAMETER\\"\\n },\\n \\"WarmupDuration\\": 5\\n }\\n },\\n \\"GmtCreate\\": \\"1667460287386\\",\\n \\"GmtModified\\": \\"1667460287386\\"\\n }\\n ],\\n \\"ServiceFQDN\\": \\"\\",\\n \\"ServicePort\\": 0,\\n \\"DnsServerList\\": [\\n \\"1.1.1.1:80\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayServiceDetail', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayServiceDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"FAF577DD-8E8E-5BE6-80CC-380E19******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', - 'title' => 'DeleteCircuitBreakerRules', ], - 'DeleteFlowRules' => [ - 'summary' => 'Deletes throttling rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGovernanceKubernetesCluster' => [ + 'summary' => 'Queries information about a Container Service for Kubernetes (ACK) cluster that has Microservices Governance enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '159871', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '24691', + 'abilityTreeNodes' => ['FEATUREmse3O985H'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'Ids', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '待删除的规则ID列表。', - 'description' => 'The IDs of the rules to be deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => true, - 'docRequired' => true, - 'example' => '[1,2]', - ], + 'schema' => ['description' => 'The region where the cluster is located. MSE supports specific regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['description' => 'The information that is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', 'title' => ''], 'Data' => [ - 'title' => '完成删除的规则ID列表。', - 'description' => 'The IDs of the rules that were deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'description' => 'The data overview.', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc30d5', 'title' => ''], + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'myCluster', 'title' => ''], + 'Region' => ['description' => 'The region where the cluster is located. MSE supports specific regions.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'K8sVersion' => ['description' => 'The Kubernetes version.', 'type' => 'string', 'example' => '1.20.11-aliyun.1', 'title' => ''], + 'NamespaceInfos' => ['description' => 'The information about namespaces.', 'type' => 'string', 'example' => '[{\\"Name\\":\\"ack-onepilot\\",\\"Tags\\":null},{\\"Name\\":\\"default\\",\\"Tags\\":{\\"mse-enable\\":\\"enabled\\"}},{\\"Name\\":\\"kube-node-lease\\",\\"Tags\\":null},{\\"Name\\":\\"kube-public\\",\\"Tags\\":null},{\\"Name\\":\\"kube-system\\",\\"Tags\\":null}]', 'title' => ''], + 'PilotStartTime' => ['description' => 'The Pilot startup time.', 'type' => 'string', 'example' => '2022-01-11T11:50:38.000+0000', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the UDF was last modified.', 'type' => 'string', 'example' => '2022-01-12T05:24:31.000+0000', 'title' => ''], + 'Namespaces' => [ + 'description' => 'The list of namespaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'The namespace structure.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The Kubernetes namespace name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'MseNamespace' => ['description' => 'The corresponding MSE namespace name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PilotVersion' => ['description' => 'The ack-onepilot component version', 'type' => 'string', 'example' => '4.1.1', 'title' => ''], + 'VersionLifeCycle' => [ + 'description' => 'The version lifecycle.', + 'enumValueTitles' => ['EXPIRED' => '过期', 'SUNSETTING' => '即将过期', 'STABLE' => '稳定', 'DEPRECATED' => '不推荐版本'], + 'type' => 'string', + 'example' => 'STABLE', + 'title' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Data\\": {\\n \\"ClusterId\\": \\"cd23228b3c80c4d4f9ad7af1d87cc30d5\\",\\n \\"ClusterName\\": \\"myCluster\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"K8sVersion\\": \\"1.20.11-aliyun.1\\",\\n \\"NamespaceInfos\\": \\"[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ack-onepilot\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"mse-enable\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\"}},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-node-lease\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-public\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-system\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null}]\\",\\n \\"PilotStartTime\\": \\"2022-01-11T11:50:38.000+0000\\",\\n \\"UpdateTime\\": \\"2022-01-12T05:24:31.000+0000\\",\\n \\"Namespaces\\": [\\n {\\n \\"Name\\": \\"default\\",\\n \\"MseNamespace\\": \\"default\\"\\n }\\n ],\\n \\"PilotVersion\\": \\"4.1.1\\",\\n \\"VersionLifeCycle\\": \\"STABLE\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetGovernanceKubernetesCluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"FAF577DD-8E8E-5BE6-80CC-380E19******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', - 'title' => 'DeleteFlowRules', ], - 'UpdateFlowRule' => [ - 'summary' => 'Updates a throttling rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetImage' => [ + 'summary' => 'Queries the maximum version number to which the current version can be upgraded.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '159855', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '43433', + 'abilityTreeNodes' => ['FEATUREmseLINUSD'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'VersionCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['title' => '', 'description' => 'The version number of the current instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ZooKeeper_3_5_5'], ], [ - 'name' => 'AppName', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'RuleId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '13', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25EA0A83-9007-4E87-808C-637BE1A****'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentVersionFullShowName' => ['title' => '', 'description' => 'The full version number of the current instance image. The parameter is in the X.X.X.X format.'."\n", 'type' => 'string', 'example' => '3.5.5.0'], + 'MaxVersionCode' => ['title' => '', 'description' => 'The code of the maximum version to which the current version can be upgraded.'."\n", 'type' => 'string', 'example' => 'ZooKeeper_3_6_3'], + 'MaxVersionFullShowName' => ['title' => '', 'description' => 'The full number of the maximum version to which the current version can be upgraded.'."\n", 'type' => 'string', 'example' => '3.6.3.0'], + 'MaxVersionChangelogUrl' => ['title' => '', 'description' => 'The URL of the changelog for the maximum version to which the current version can be upgraded.'."\n", 'type' => 'string', 'example' => 'https://xxxxx'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The throttling threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '30', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25EA0A83-9007-4E87-808C-637BE1A****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"CurrentVersionFullShowName\\": \\"3.5.5.0\\",\\n \\"MaxVersionCode\\": \\"ZooKeeper_3_6_3\\",\\n \\"MaxVersionFullShowName\\": \\"3.6.3.0\\",\\n \\"MaxVersionChangelogUrl\\": \\"https://xxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetImage', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'true', ], ], + ], + ], + 'GetImportFileUrl' => [ + 'summary' => 'Obtains the URL that is used to upload a configuration file when you import the configuration file into a Microservices Engine (MSE) Nacos instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'ControlBehavior', - 'in' => 'query', - 'schema' => [ - 'description' => 'The throttling effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' fast failure'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' in queue'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - '', - 2 => '', - ], - 'example' => '0', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76156', + 'abilityTreeNodes' => ['FEATUREmseEPOTV0'], + ], + 'parameters' => [ [ - 'name' => 'MaxQueueingTimeMs', + 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'description' => 'The timeout period. Unit: milliseconds. This parameter is required when the value of ControlBehavior is set to 2.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '500', - ], + 'schema' => ['description' => 'The file type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'application/zip', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-7pp2b****', 'title' => ''], ], [ - 'name' => 'LimitApp', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the namespace.', 'type' => 'string', 'required' => false, 'example' => '12788f73-9848-4388-98f1-507778f2****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -21427,217 +14278,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '19488A00-4AF5-55E1-A689-98BA9F5E7441', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'* `true`: The request was successful. '."\n" + .'* `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\\\*\\\\*%s\\\\*\\\\* variable in the **ErrMessage** parameter.\\n\\n> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => 'The data of the node.'."\n", + 'description' => 'The details of the data.', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => 'The name of the API resource.'."\n", - 'type' => 'string', - 'example' => '/c', - ], - 'ControlBehavior' => [ - 'description' => 'The throttling effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' fast failure'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' in queue'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - 2 => '', - ], - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Threshold' => [ - 'description' => 'The throttling threshold.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'Enable' => [ - 'description' => 'Indicates whether the rule was enabled.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'fasle' => '', - ], - 'example' => 'true', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'hpn9ac29kz@e31a4b871******', - ], - 'LimitApp' => [ - 'type' => 'string', - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The request was successful.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The request failed.'."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'Url' => ['description' => 'The URL that is used to upload the configuration file.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"19488A00-4AF5-55E1-A689-98BA9F5E7441\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetImportFileUrl', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).\\n', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetImportFileUrl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 12,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/c\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 5,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hpn9ac29kz@e31a4b871******\\",\\n \\"LimitApp\\": \\"Spring-cloud-a\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateFlowRule', ], - 'ListFlowRules' => [ - 'summary' => 'Obtains a list of throttling rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetKubernetesSource' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -21646,1056 +14349,466 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '159811', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '24906', + 'abilityTreeNodes' => ['FEATUREmseE7U1OL'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xx-demo', - ], - ], - [ - 'name' => 'ResourceSearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], - ], - [ - 'name' => 'Resource', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c5d1aadb7df646cfb7065fbf75c1****'], ], [ - 'name' => 'PageIndex', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1t50e045b5g7i3p****'], ], [ - 'name' => 'PageSize', + 'name' => 'IsAll', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to obtain the information about all Kubernetes clusters. If you set the value to false, only the information about unassociated clusters is obtained.'."\n", 'type' => 'boolean', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The request was successful.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The request failed.'."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'RuleId' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'finance', - ], - 'Resource' => [ - 'description' => 'The name of the interface resource.'."\n", - 'type' => 'string', - 'example' => '/a', - ], - 'ResourceType' => [ - 'description' => 'Interface resource type.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ControlBehavior' => [ - 'description' => 'The throttling effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' fast failure'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' in queue'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - 2 => '', - ], - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Threshold' => [ - 'description' => 'The throttling threshold.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'Enable' => [ - 'description' => 'Indicates whether the throttling rule was enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'AppId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@5f1b08becb*****', - ], - 'RegionId' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'FallbackObject' => [ - 'description' => 'The throttling behavior.'."\n", - 'type' => 'string', - 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', - ], - 'MetricType' => [ - 'description' => 'The statistical dimension. The value 1 indicates that the number of accepted requests is used for statistics.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TrafficTags' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'object', - 'example' => '{\\"origin\\":\\"default\\"}', - ], - 'LimitApp' => [ - 'description' => 'Requests source application.', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the ACK cluster.'."\n", 'type' => 'string', 'example' => 'k8s-demo'], + 'Cluster' => ['description' => 'The ID of the ACK cluster.'."\n", 'type' => 'string', 'example' => 'cbc1efca895a64af097ff00b26f3f****'], ], ], ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], ], - 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"k8s-demo\\",\\n \\"Cluster\\": \\"cbc1efca895a64af097ff00b26f3f****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetKubernetesSource', + 'summary' => 'Obtains sources of all Container Service for Kubernetes (ACK) services in a gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetKubernetesSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 2,\\n \\"AppName\\": \\"finance\\",\\n \\"Resource\\": \\"/a\\",\\n \\"ResourceType\\": 1,\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 10,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"MetricType\\": 1,\\n \\"TrafficTags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 11\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListFlowRules', ], - 'CreateFlowRule' => [ - 'summary' => 'Creates a throttling rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetLocalityRule' => [ + 'summary' => 'Retrieves the Intra-zone Provider First rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '163217', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '45915', + 'abilityTreeNodes' => ['FEATUREmseZ3XXPX'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The region of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => 'The name of the Microservices Engine (MSE) namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'example-app', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'Threshold', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The throttling threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'hgxznfcvbe@be2c0228f******', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The source of the rule. This field is optional.', 'type' => 'string', 'required' => false, 'example' => 'edasmsc', 'title' => ''], ], [ - 'name' => 'Resource', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh and en. zh is the default value, which indicates Chinese. en indicates English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the API resource.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/b', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D3971C60-3F07-58B0-8EA0-A194********', 'title' => ''], + 'Data' => ['description' => 'The data returned.', 'type' => 'string', 'example' => '{'."\n" + .' "pageNumber":0,'."\n" + .' "namespaceId":"cn-hangzhou",'."\n" + .' "enable":false,'."\n" + .' "appId":"hkhon1po62@3aa3582********",'."\n" + .' "pageSize":0,'."\n" + .' "region":"cn-hangzhou",'."\n" + .' "routeRules":['."\n" + .' {'."\n" + .' "threshold":0.2,'."\n" + .' "tags":[]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ib09eblv6p@c3df23522******', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"D3971C60-3F07-58B0-8EA0-A194********\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"pageNumber\\\\\\":0,\\\\n \\\\\\"namespaceId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"enable\\\\\\":false,\\\\n \\\\\\"appId\\\\\\":\\\\\\"hkhon1po62@3aa3582********\\\\\\",\\\\n \\\\\\"pageSize\\\\\\":0,\\\\n \\\\\\"region\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"routeRules\\\\\\":[\\\\n {\\\\n \\\\\\"threshold\\\\\\":0.2,\\\\n \\\\\\"tags\\\\\\":[]\\\\n }\\\\n ]\\\\n}\\",\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'GetLocalityRule', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ControlBehavior', - 'in' => 'query', - 'schema' => [ - 'description' => 'The throttling effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: fast failure'."\n" - .'* 2: in queue'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - '', - 2 => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLocalityRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => '0', - 'default' => '0', ], ], + ], + ], + 'GetLosslessRuleByApp' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'MaxQueueingTimeMs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timeout period. Unit: milliseconds. This value is required if the ControlBehavior parameter is set to 2.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173262', + 'abilityTreeNodes' => ['FEATUREmse9OTHB7'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'region id, such as cn-hangzhou', 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enum' => [ - '0', - '1', - '2', - '4', - '3', - ], - ], + 'schema' => ['title' => 'Key word of search lossless list', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example-app'], ], [ - 'name' => 'LimitApp', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the MSE namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => 'appId', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522baa***'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => 'The name of the API resource.'."\n", - 'type' => 'string', - 'example' => 'app', - ], - 'ControlBehavior' => [ - 'description' => 'The throttling effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' fast failure'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' in queue'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - 2 => '', - ], - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Threshold' => [ - 'description' => 'The throttling threshold.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'Enable' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@54e1f42f3******', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LimitApp' => [ - 'type' => 'string', - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'AppName' => ['title' => 'appName', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'spring-cloud-a'], + 'AppId' => ['title' => 'appId', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => 'hkhon1po62@24810bf4364a***'], + 'Count' => ['title' => 'instance\'s count of app', 'description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Enable' => ['title' => 'rule is open or close', 'description' => 'Indicates whether graceful start is enabled. Valid values:'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", 'type' => 'boolean', 'example' => 'true'], + 'WarmupTime' => ['description' => 'The prefetching duration. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '120'], + 'DelayTime' => ['description' => 'The registration latency. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'FuncType' => ['title' => 'warmup function type, 2 means f(x)=x^2', 'description' => 'The slope of the prefetching curve.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Aligned' => ['title' => 'microservices lifecycle aligns to k8s\'s or NOT', 'description' => 'Indicates whether service registration is complete before readiness probe.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Related' => ['title' => 'K8s\'s HPA is related to warmup or NOT', 'description' => 'Indicates whether service prefetching is complete before readiness probe.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'LossLessDetail' => ['title' => 'show lossLess offline&online detail', 'description' => 'Indicates whether online and offline processing details are displayed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Notice' => ['title' => 'enable lossLess offline active notification', 'description' => 'Indicates whether notification is enabled.'."\n", 'type' => 'boolean', 'example' => 'false'], ], - 'example' => 'true', ], ], - 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"AppId\\": \\"hkhon1po62@24810bf4364a***\\",\\n \\"Count\\": 1,\\n \\"Enable\\": true,\\n \\"WarmupTime\\": 120,\\n \\"DelayTime\\": 60,\\n \\"FuncType\\": 2,\\n \\"Aligned\\": true,\\n \\"Related\\": false,\\n \\"LossLessDetail\\": true,\\n \\"Notice\\": false\\n }\\n}","type":"json"}]', + 'title' => 'GetLosslessRuleByApp', + 'summary' => 'Queries the rules for graceful start and shutdown of an application.', + 'description' => 'You can call this operation to query the rules for graceful start and shutdown of an application.'."\n" + ."\n" + .'You can query the rules for graceful start and shutdown of an application preferentially by using the AppId parameter.'."\n" + ."\n" + .'If the AppId parameter is left empty, you can use the RegionId, Namespace, and AppName parameters to query the rules for graceful start and shutdown of an application.'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLosslessRuleByApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 12,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"app\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 200,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@54e1f42f3******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateFlowRule', ], - 'CreateCircuitBreakerRule' => [ - 'summary' => 'Creates a circuit breaking rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetMseFeatureSwitch' => [ + 'summary' => 'Queries the information about the MSE feature switch.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '167810', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'Threshold', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'docRequired' => true, - 'example' => '0.8', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Enable', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => 'Specifies whether to enable the rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6B4653A3-8D9C-5FDC-BB0C-936D40E9794B', 'title' => ''], + 'Result' => ['description' => 'The returned result.'."\n", 'type' => 'object', 'example' => '{\'nacos_config_encrypt\': False}', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => 'true', - ], - ], - [ - 'name' => 'Resource', - 'in' => 'query', - 'schema' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => 'The name of the interface to which the rule applies. The interface name must be the same as the name on the interface details page in the console.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/a', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '集群所在地域。', - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], - [ - 'name' => 'Strategy', - 'in' => 'query', - 'schema' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => 'The threshold type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' slow call proportion'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' abnormal proportion'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'RetryTimeoutMs', - 'in' => 'query', - 'schema' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', - 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period. The value must be an integral multiple of 1,000. Default value: 10000. This value indicates 10 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], - [ - 'name' => 'StatIntervalMs', - 'in' => 'query', - 'schema' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', - 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes. The default value is 20000. This value indicates 20 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20000', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"6B4653A3-8D9C-5FDC-BB0C-936D40E9794B\\",\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetMseFeatureSwitch', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'MaxAllowedRtMs', - 'in' => 'query', - 'schema' => [ - 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseFeatureSwitch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetMseSource' => [ + 'summary' => 'Queries the existing Microservices Engine (MSE) Nacos instances that are service sources of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'MinRequestAmount', - 'in' => 'query', - 'schema' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', - 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '24939', + 'abilityTreeNodes' => ['FEATUREmseZM8SC5', 'FEATUREmseRZJSHZ'], + ], + 'parameters' => [ [ - 'name' => 'HalfOpenBaseAmountPerStep', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复每步最小通过数目，默认值为1。', - 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', 'title' => ''], ], [ - 'name' => 'HalfOpenRecoveryStepNum', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复阶段数，默认值为1。', - 'description' => 'The number of circuit breaking recovery steps. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'VPC ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1t50e045b5g7i3p****', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: custom interface'."\n" - .'* 1: web'."\n" - .'* 2: RPC'."\n" - .'* 3: route'."\n" - .'* 4: SQL'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - 'WEB', - 'RPC', - 'ROUTE', - 'SQL', - ], - 'example' => '0', - 'enum' => [ - '0', - '1', - '2', - '4', - '3', - ], - ], + 'schema' => ['description' => 'The MSE engine type. Valid values:'."\n" + ."\n" + .'* NACOS'."\n" + .'* ZOOKEEPER'."\n", 'type' => 'string', 'required' => false, 'example' => 'NACOS', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'title' => '', 'description' => 'The language of the response. Valid values:'."\n" ."\n" .'* zh: Chinese'."\n" .'* en: English'."\n", 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['en' => '', 'zh' => ''], 'example' => 'zh', ], ], @@ -22703,241 +14816,83 @@ 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Code' => [ - 'title' => '响应码。', - 'description' => 'The response code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5EB2D865-B43F-5526-8F92-857718CF73A2'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '规则信息。', - 'description' => 'The details of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => 'The ID of the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", - 'type' => 'string', - 'example' => '/a', - ], - 'StatIntervalMs' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'Threshold' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Strategy' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => 'The threshold type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' Slow call ratio'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' Abnormal proportion'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'RetryTimeoutMs' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'RegionId' => [ - 'title' => '集群所在地域。', - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MaxAllowedRtMs' => [ - 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'MinRequestAmount' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HalfOpenBaseAmountPerStep' => [ - 'title' => '熔断恢复每步最小通过数目。', - 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'HalfOpenRecoveryStepNum' => [ - 'title' => '熔断恢复阶段数。', - 'description' => 'The number of circuit breaking recovery steps.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The ID of the instance'."\n", 'type' => 'string', 'example' => 'mse_prepaid_public_cn-7pp2eec****', 'title' => ''], + 'Address' => ['description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'mse-af1****-nacos-ans.mse.aliyuncs.com:8848', 'title' => ''], + 'Type' => ['description' => 'The type.'."\n", 'type' => 'string', 'example' => 'Nacos', 'title' => ''], + 'Name' => ['description' => 'The name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of cluster.'."\n", 'type' => 'string', 'example' => 'mse_', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EB2D865-B43F-5526-8F92-857718CF73A2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"mse_prepaid_public_cn-7pp2eec****\\",\\n \\"Address\\": \\"mse-af1****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"Type\\": \\"Nacos\\",\\n \\"Name\\": \\"test\\",\\n \\"ClusterId\\": \\"mse_\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetMseSource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"StatIntervalMs\\": 20000,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"Strategy\\": 0,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateCircuitBreakerRule', ], - 'ListCircuitBreakerRules' => [ - 'summary' => 'Queries a list of circuit breaking rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetNacosConfig' => [ + 'summary' => 'Get Nacos Configuration', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -22946,845 +14901,574 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '167823', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17035', + 'abilityTreeNodes' => ['FEATUREmseEUE1FY'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'ResourceSearchKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '查找包含接口关键字的防护规则。', - 'description' => 'This parameter is used for fuzzy match of circuit breaking rules.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-i7m2h0****', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], + 'schema' => ['description' => 'Data ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'halvie-mp-item****', 'title' => ''], ], [ - 'name' => 'Resource', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'title' => '查找指定接口的防护规则。', - 'description' => 'This parameter is used for exact match of circuit breaking rules.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], + 'schema' => ['description' => 'Configuration group information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'common', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '起始页。', - 'description' => 'The start page of the returned pages. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Namespace ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Beta', 'in' => 'query', - 'schema' => [ - 'title' => '页大小。', - 'description' => 'The number of entries per page. Default value: 6.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Whether it is a Beta release.'."\n" + ."\n" + .'- `true`: Yes'."\n" + .'- `false`: No', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应码。', - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '规则信息。', - 'description' => 'The details of the rule.'."\n", + 'Message' => ['description' => 'Message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD', 'title' => ''], + 'Configuration' => [ + 'description' => 'Configuration information.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'title' => '返回结果。', - 'description' => 'The returned result.'."\n", + 'Type' => ['description' => 'Format of the configuration content.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'AppName' => ['description' => 'Application name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Tags' => ['description' => 'Tags of the configuration.', 'type' => 'string', 'example' => 'context', 'title' => ''], + 'Md5' => ['description' => 'Message digest of the configuration.', 'type' => 'string', 'example' => '123rfsdf3', 'title' => ''], + 'DataId' => ['description' => 'Configuration ID.', 'type' => 'string', 'example' => 'log.yaml', 'title' => ''], + 'Content' => ['description' => 'Configuration content.', 'type' => 'string', 'example' => 'log.level=error', 'title' => ''], + 'Group' => ['description' => 'Configuration group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Desc' => ['description' => 'Configuration description.', 'type' => 'string', 'example' => 'Testdedicateduse', 'title' => ''], + 'EncryptedDataKey' => ['description' => 'Encrypted key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'BetaIps' => ['description' => 'List of IPs for Beta release.', 'type' => 'string', 'example' => '1.1.XX.XX，2.2.XX.XX', 'title' => ''], + 'GrayVersions' => [ + 'title' => '当前配置的灰度版本信息', + 'description' => 'Current gray version information', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'RuleId' => [ - 'title' => '规则ID。', - 'description' => 'The ID of the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", - 'type' => 'string', - 'example' => '/a', - ], - 'ResourceType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Strategy' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => 'The threshold type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' slow call proportion'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' abnormal proportion'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'Threshold' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => 'Indicates whether the rule was enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RetryTimeoutMs' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'StatIntervalMs' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'RegionId' => [ - 'title' => '集群所在地域。', - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'FallbackObject' => [ - 'title' => '规则绑定的行为。', - 'description' => 'The behavior that was bound to the rule.'."\n", + 'Type' => [ + 'title' => '灰度类型', + 'description' => 'Gray type', 'type' => 'string', - 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', - ], - 'MaxAllowedRtMs' => [ - 'title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'description' => 'The maximum RT. Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'MinRequestAmount' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HalfOpenBaseAmountPerStep' => [ - 'title' => '熔断恢复每步最小通过数目。', - 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'HalfOpenRecoveryStepNum' => [ - 'title' => '熔断恢复阶段数。', - 'description' => 'The number of circuit breaking recovery steps.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'example' => 'Beta', + 'enumValueTitles' => ['Tags' => 'Tags', 'Beta' => 'Beta'], ], + 'Name' => ['title' => '灰度版本名称', 'description' => 'Gray version name', 'type' => 'string', 'example' => 'test'], + 'Rule' => ['title' => '当前灰度版本的规则', 'description' => 'Rules of the current gray version', 'type' => 'string', 'example' => 'a=b'], + 'Priority' => ['title' => '当前灰度规则的优先级', 'description' => 'The priority of the current gray rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'PageNumber' => [ - 'title' => '起始页。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页大小。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'title' => '总页数。', - 'description' => 'The total number of pages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'The result of the request, with values as follows:'."\n" + .'- `true`: The request was successful.'."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"ResourceType\\": 1,\\n \\"Strategy\\": 0,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"StatIntervalMs\\": 20000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 3\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListCircuitBreakerRules', - ], - 'UpdateCircuitBreakerRule' => [ - 'summary' => 'Updates a circuit breaking rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'msc', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD\\",\\n \\"Configuration\\": {\\n \\"Type\\": \\"text\\",\\n \\"AppName\\": \\"test\\",\\n \\"Tags\\": \\"context\\",\\n \\"Md5\\": \\"123rfsdf3\\",\\n \\"DataId\\": \\"log.yaml\\",\\n \\"Content\\": \\"log.level=error\\",\\n \\"Group\\": \\"test\\",\\n \\"Desc\\": \\"Testdedicateduse\\",\\n \\"EncryptedDataKey\\": \\"key\\",\\n \\"BetaIps\\": \\"1.1.XX.XX，2.2.XX.XX\\",\\n \\"GrayVersions\\": [\\n {\\n \\"Type\\": \\"Beta\\",\\n \\"Name\\": \\"test\\",\\n \\"Rule\\": \\"a=b\\",\\n \\"Priority\\": 20\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Get Nacos Configuration', + 'description' => '> This OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'GetNacosHistoryConfig' => [ + 'summary' => 'Queries the historical details of Nacos configuration changes.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '167822', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-st220g9ka02', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The ID of the data.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'msg-center.main.yaml', 'title' => ''], ], [ - 'name' => 'Threshold', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => '0.8', - ], + 'schema' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => 'Specifies whether to enable the rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'Nid', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], + 'schema' => ['description' => 'The version ID of the configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40****', 'title' => ''], ], [ - 'name' => 'Strategy', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => 'The threshold type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' slow call proportion'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' abnormal proportion'."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - '', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Configuration' => [ + 'description' => 'The configuration information.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Md5' => ['description' => 'The MD5 value of the configuration.'."\n", 'type' => 'string', 'example' => '23sdf32f****', 'title' => ''], + 'DataId' => ['description' => 'The ID of the configuration.'."\n", 'type' => 'string', 'example' => 'test.yaml', 'title' => ''], + 'Content' => ['description' => 'The content of the configuration.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Group' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'example' => 'public', 'title' => ''], + 'OpType' => ['description' => 'The configuration type.'."\n", 'type' => 'string', 'example' => 'text', 'title' => ''], + 'EncryptedDataKey' => ['description' => 'The encryption key.'."\n", 'type' => 'string', 'example' => '23fds****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => '0', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RetryTimeoutMs', - 'in' => 'query', - 'schema' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', - 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period. The value must be an integral multiple of 1,000. Default value: 10000. This value indicates 10 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], - [ - 'name' => 'StatIntervalMs', - 'in' => 'query', - 'schema' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', - 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes. The default value is 20000. This value indicates 20 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20000', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'MaxAllowedRtMs', - 'in' => 'query', - 'schema' => [ - 'title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Configuration\\": {\\n \\"AppName\\": \\"test\\",\\n \\"Md5\\": \\"23sdf32f****\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Content\\": \\"test\\",\\n \\"Group\\": \\"public\\",\\n \\"OpType\\": \\"text\\",\\n \\"EncryptedDataKey\\": \\"23fds****\\"\\n },\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetNacosHistoryConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'MinRequestAmount', - 'in' => 'query', - 'schema' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', - 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosHistoryConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetOverview' => [ + 'summary' => 'Queries overview information about Microservices Governance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'HalfOpenBaseAmountPerStep', - 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复每步最小通过数目，默认值为1。', - 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'HalfOpenRecoveryStepNum', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复阶段数，默认值为1。', - 'description' => 'The number of circuit breaking recovery steps. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The query time. Unit: days. For example, if you set this parameter to 30, the governance rules within the last 30 days are queried.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '规则ID。', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Data' => ['description' => 'The details of the data.'."\n", 'type' => 'string', 'example' => 'data', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": \\"data\\",\\n \\"Code\\": 1,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'GetOverview', + 'description' => 'You can call this operation to query overview information about service governance.'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:GetOverview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetPluginConfig' => [ + 'summary' => 'Retrieves the plug-in configuration.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '128638', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", 'title' => ''], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the gateway plugin.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'zh: Chinese and en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '500', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'message', 'title' => ''], 'Data' => [ - 'description' => 'The details of the rule.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => 'The ID of the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", - 'type' => 'string', - 'example' => '/a', - ], - 'Strategy' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => 'The threshold type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' slow call proportion'."\n" - ."\n" - .' '."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" + 'Id' => ['description' => 'The plugin ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PrimaryUser' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Type' => [ + 'description' => 'The plugin type. Valid values:'."\n" ."\n" - .' abnormal proportion'."\n" + .'- 0: http filter'."\n" ."\n" - .' '."\n", + .'- 1: network filter', + 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], 'example' => '0', + 'title' => '', ], - 'Threshold' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RetryTimeoutMs' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'StatIntervalMs' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'MaxAllowedRtMs' => [ - 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'description' => 'The maximum RT. Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'MinRequestAmount' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HalfOpenBaseAmountPerStep' => [ - 'title' => '熔断恢复每步最小通过数目。', - 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'HalfOpenRecoveryStepNum' => [ - 'title' => '熔断恢复阶段数。', - 'description' => 'The number of circuit breaking recovery steps.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Category' => ['description' => 'The plugin category. Valid values:'."\n" + ."\n" + .'0: Custom'."\n" + ."\n" + .'1: Permission Authorization'."\n" + ."\n" + .'2: Security Protection'."\n" + ."\n" + .'3: Transport Protocol'."\n" + ."\n" + .'4: Traffic Control'."\n" + ."\n" + .'5: Traffic Observation', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'The plugin name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Version' => ['description' => 'The plugin version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Summary' => ['description' => 'The plugin summary.', 'type' => 'string', 'example' => 'This is a plugin.', 'title' => ''], + 'SummaryEn' => ['description' => 'The plugin summary in English.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Readme' => ['description' => 'The README content.', 'type' => 'string', 'example' => 'read me', 'title' => ''], + 'ReadmeEn' => ['description' => 'The README content in English.', 'type' => 'string', 'example' => 'read me', 'title' => ''], + 'ConfigExample' => ['description' => 'The plugin configuration example.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Phase' => ['description' => 'The execution phase of the plugin. Valid values:'."\n" + ."\n" + .'0: Default Phase'."\n" + ."\n" + .'1: Authentication Phase'."\n" + ."\n" + .'2: Authorization Phase'."\n" + ."\n" + .'3: Statistics Phase', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Priority' => ['description' => 'The execution priority. A larger value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ConfigCheck' => ['description' => 'The configuration check.', 'type' => 'string', 'example' => '# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain "name", "age", "friends" fields'."\n" + .'name: John'."\n" + .'age: 18'."\n" + .'friends:'."\n" + .'- David'."\n" + .'- Anne', 'title' => ''], + 'Mode' => ['description' => 'The mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WasmLang' => ['description' => 'The Wasm implementation language. Valid values:'."\n" + ."\n" + .'0: C++'."\n" + ."\n" + .'1: TinyGo'."\n" + ."\n" + .'2: Rust'."\n" + ."\n" + .'3: AssemblyScript'."\n" + ."\n" + .'4: Zig', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ImageName' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'PublishState' => ['description' => 'The publishing status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'0: Disabled'."\n" + ."\n" + .'1: Enabled', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GatewayConfigList' => [ + 'description' => 'The list of configurations for the plugin.', + 'type' => 'array', + 'items' => [ + 'description' => 'A plugin configuration.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The plugin configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', 'title' => ''], + 'PluginId' => ['description' => 'The gateway plugin ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the plugin configuration is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Config' => ['description' => 'The plugin configuration.', 'type' => 'string', 'example' => '# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain "name", "age", "friends" fields'."\n" + .'name: John'."\n" + .'age: 18'."\n" + .'friends:'."\n" + .'- David'."\n" + .'- Anne', 'title' => ''], + 'ConfigLevel' => ['description' => 'The application scope of the plugin. Valid values:'."\n" + ."\n" + .'0: Global'."\n" + ."\n" + .'1: Domain'."\n" + ."\n" + .'2: Route', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResourceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Name' => ['description' => 'The name of the resource, which can be a domain or route name.', 'type' => 'string', 'example' => 'test-route', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of resources, which can be domains or routes depending on the value of `ConfigLevel`.', + 'title' => '', + 'example' => '', + ], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1667309705000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1667309705000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RouteConfigStartIndex' => ['description' => 'The starting index of route-level rules in the `GatewayConfigList` array. If no route-level rules exist, the value is -1.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DomainConfigStartIndex' => ['description' => 'The starting index of domain-level rules in the `GatewayConfigList` array. If no domain-level rules exist, the value is -1.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'GatewayConfigStartIndex' => ['description' => 'The index of the instance-level rule in the `GatewayConfigList` array. If no instance-level rule exists, the value is -1.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'VersionJson' => ['description' => 'A JSON string that represents a list of gateway plugin versions.', 'type' => 'string', 'example' => '[{"id":1, "version": "1.0.0"}]', 'title' => ''], ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The request was successful.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The request failed.'."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"message\\",\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"Type\\": 0,\\n \\"Category\\": 0,\\n \\"Name\\": \\"name\\",\\n \\"Version\\": \\"v1\\",\\n \\"Summary\\": \\"This is a plugin.\\",\\n \\"SummaryEn\\": \\"\\",\\n \\"Readme\\": \\"read me\\",\\n \\"ReadmeEn\\": \\"read me\\",\\n \\"ConfigExample\\": \\"\\",\\n \\"Phase\\": 0,\\n \\"Priority\\": 1,\\n \\"ConfigCheck\\": \\"# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain \\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"friends\\\\\\" fields\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"Mode\\": 0,\\n \\"WasmLang\\": 0,\\n \\"ImageName\\": \\"name\\",\\n \\"PublishState\\": 1,\\n \\"Status\\": \\"1\\",\\n \\"GatewayConfigList\\": [\\n {\\n \\"Id\\": 1,\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-ubuwqygbq4783gqb2y3f87q****\\",\\n \\"PluginId\\": 1,\\n \\"Enable\\": true,\\n \\"Config\\": \\"# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain \\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"friends\\\\\\" fields\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"ConfigLevel\\": 0,\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 0,\\n \\"Name\\": \\"test-route\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"1667309705000\\",\\n \\"GmtModified\\": \\"1667309705000\\"\\n }\\n ],\\n \\"RouteConfigStartIndex\\": 0,\\n \\"DomainConfigStartIndex\\": 5,\\n \\"GatewayConfigStartIndex\\": 7,\\n \\"VersionJson\\": \\"[{\\\\\\"id\\\\\\":1, \\\\\\"version\\\\\\": \\\\\\"1.0.0\\\\\\"}]\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetPluginConfig', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetPluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Strategy\\": 0,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"StatIntervalMs\\": 20000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateCircuitBreakerRule', + 'translator' => 'machine', ], - 'ListWebFlowRules' => [ - 'summary' => 'Queries hot parameter protection rules for HTTP requests.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetPlugins' => [ + 'summary' => 'Retrieves plugins from the plugin marketplace.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23793,549 +15477,394 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '164286', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '128636', + 'abilityTreeNodes' => ['FEATUREmse7RUWJD'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'default' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'ResourceSearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'flow', - ], - ], - [ - 'name' => 'AppId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b22qb1****@2f0586be4b1****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', 'title' => ''], ], [ - 'name' => 'Resource', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/flow', - ], + 'schema' => ['description' => 'The category of the plugin. Valid values:'."\n" + ."\n" + .'- 0: user-defined'."\n" + ."\n" + .'- 1: authentication and authorization'."\n" + ."\n" + .'- 2: security protection'."\n" + ."\n" + .'- 3: transport protocol'."\n" + ."\n" + .'- 4: traffic control'."\n" + ."\n" + .'- 5: traffic monitoring', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'EnableOnly', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'If true, returns only enabled plugins.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the plugin.', 'type' => 'string', 'required' => false, 'example' => 'key-auth', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response.'."\n" + ."\n" + .'Valid values: zh (Chinese) and en (English).', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4AE73569-304C-5AA9-AE11-C1D99C7D1689', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '500', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'DynamicCode' => ['description' => 'The placeholder in the dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'message', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'StatIntervalMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'RuleId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/flow', - ], - 'ResourceType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ControlBehavior' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Burst' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ResourceMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParamItem' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hkhon1XXXX@c3df23522bXXXXX', - ], - 'MetricType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'FallbackObject' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '36', + 'description' => 'A list of plugins.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the plugin.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The plugin ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PrimaryUser' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Category' => ['description' => 'The plugin category. Valid values:'."\n" + ."\n" + .'0: user-defined'."\n" + ."\n" + .'1: authentication and authorization'."\n" + ."\n" + .'2: security protection'."\n" + ."\n" + .'3: transport protocol'."\n" + ."\n" + .'4: traffic control'."\n" + ."\n" + .'5: traffic monitoring', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'The plugin name.', 'type' => 'string', 'example' => 'key-auth', 'title' => ''], + 'Version' => ['description' => 'The plugin version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Summary' => ['description' => 'The plugin summary.', 'type' => 'string', 'example' => 'This is a plugin.', 'title' => ''], + 'SummaryEn' => ['description' => 'The English summary.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Phase' => ['description' => 'The plugin execution phase. Valid values:'."\n" + ."\n" + .'- 0: default phase'."\n" + ."\n" + .'- 1: authentication phase'."\n" + ."\n" + .'- 2: authorization phase'."\n" + ."\n" + .'- 3: statistics phase', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Priority' => ['description' => 'The plugin execution priority. A higher value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ConfigCheck' => ['description' => 'The configuration validation schema.', 'type' => 'string', 'example' => '# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain "name", "age", "friends" fields'."\n" + .'name: John'."\n" + .'age: 18'."\n" + .'friends:'."\n" + .'- David'."\n" + .'- Anne', 'title' => ''], + 'WasmLang' => ['description' => 'The language in which the Wasm plugin is implemented. Valid values:'."\n" + ."\n" + .'- 0: C++'."\n" + ."\n" + .'- 1: TinyGo'."\n" + ."\n" + .'- 2: Rust'."\n" + ."\n" + .'- 3: AssemblyScript'."\n" + ."\n" + .'- 4: Zig', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PublishState' => ['description' => 'The publishing status. Valid values:'."\n" + ."\n" + .'- 0: Succeeded'."\n" + ."\n" + .'- 1: Publishing'."\n" + ."\n" + .'- 2: Failed', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WasmFile' => ['description' => 'The OSS URL of the Wasm plugin.', 'type' => 'string', 'example' => 'https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm', 'title' => ''], + 'Status' => ['description' => 'The plugin status. Valid values:'."\n" + ."\n" + .'- 0: disabled'."\n" + ."\n" + .'- 1: enabled', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Mode' => ['description' => 'The plugin type. Valid values:'."\n" + ."\n" + .'- 0: Wasm plugin'."\n" + ."\n" + .'- 2: Lua plugin', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MaxVersion' => ['description' => 'The latest version.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'NewVersionPublishingFlag' => ['description' => 'Indicates whether the latest version is being published.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"message\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"Category\\": 0,\\n \\"Name\\": \\"key-auth\\",\\n \\"Version\\": \\"v1\\",\\n \\"Summary\\": \\"This is a plugin.\\",\\n \\"SummaryEn\\": \\"\\",\\n \\"Phase\\": 1,\\n \\"Priority\\": 1,\\n \\"ConfigCheck\\": \\"# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain \\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"friends\\\\\\" fields\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"WasmLang\\": 0,\\n \\"PublishState\\": 1,\\n \\"WasmFile\\": \\"https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm\\",\\n \\"Status\\": \\"1\\",\\n \\"Mode\\": 0,\\n \\"MaxVersion\\": \\"1.0.0\\",\\n \\"NewVersionPublishingFlag\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetPlugins', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetPlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4AE73569-304C-5AA9-AE11-C1D99C7D1689\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"RuleId\\": \\"1\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ResourceType\\": 1,\\n \\"ControlBehavior\\": 0,\\n \\"Burst\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"ResourceMode\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\",\\n \\"AppId\\": \\"hkhon1XXXX@c3df23522bXXXXX\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 36\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListWebFlowRules', + 'translator' => 'machine', ], - 'CreateWebFlowRule' => [ - 'summary' => 'Creates a hot parameter protection rule for HTTP requests.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetServiceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '164156', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '17043', + 'abilityTreeNodes' => ['FEATUREmseW9QIF2'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - 'default' => 'default', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou'], ], [ - 'name' => 'AppName', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The type of the framework.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dubbo'], ], [ - 'name' => 'Threshold', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '阈值', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'xxx@xxx'], ], [ - 'name' => 'Enable', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '规则状态', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.xxx'], ], [ - 'name' => 'Resource', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'title' => '资源名（接口名）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/flow', - ], + 'schema' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], ], [ - 'name' => 'Burst', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '针对突发请求额外允许的请求数目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'AppId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1****@c3df23522******', - ], + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'xxx-xxx-xxx'], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'EdasAppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test'], + 'DubboApplicationName' => ['description' => 'The name of the Dubbo application.'."\n", 'type' => 'string', 'example' => 'dubbo-application'], + 'Version' => ['description' => 'The version information.'."\n", 'type' => 'string', 'example' => '1.0.0'], + 'SpringApplicationName' => ['description' => 'The name of the Spring application.'."\n", 'type' => 'string', 'example' => 'spring-application'], + 'RegistryType' => ['description' => 'The type of the service registry.'."\n", 'type' => 'string', 'example' => 'nacos'], + 'ServiceType' => ['description' => 'The type of the service.'."\n", 'type' => 'string', 'example' => 'dubbo'], + 'ServiceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'com.alibaba.xxx'], + 'Methods' => [ + 'description' => 'The methods.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The methods.'."\n", + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'description' => 'The paths.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The path of the service.'."\n", 'type' => 'string', 'example' => '/path'], + ], + 'ParameterTypes' => [ + 'description' => 'The data types of the parameters.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The data type of the parameter.'."\n", 'type' => 'string', 'example' => 'int'], + ], + 'RequestMethods' => [ + 'description' => 'The methods.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The method.'."\n", 'type' => 'string', 'example' => 'sayHello'], + ], + 'Name' => ['description' => 'The name of the method.'."\n", 'type' => 'string', 'example' => 'sayHello'], + 'MethodController' => ['description' => 'The controller of the method.'."\n", 'type' => 'string', 'example' => 'com.alibaba.SayHelloController'], + 'ReturnType' => ['description' => 'The type of the return value.'."\n", 'type' => 'string', 'example' => 'int'], + ], + ], + ], + 'Metadata' => ['description' => 'The metadata.'."\n", 'type' => 'object', 'example' => '{}'], + 'Group' => ['description' => 'The group.'."\n", 'type' => 'string', 'example' => 'dubbo'], + ], + ], + ], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'ControlBehavior', - 'in' => 'query', - 'schema' => [ - 'title' => '流控方式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - '', - 2 => '', - ], - 'example' => '0', - 'default' => '0', - 'enum' => [ - '0', - '2', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": [\\n {\\n \\"EdasAppName\\": \\"test\\",\\n \\"DubboApplicationName\\": \\"dubbo-application\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"SpringApplicationName\\": \\"spring-application\\",\\n \\"RegistryType\\": \\"nacos\\",\\n \\"ServiceType\\": \\"dubbo\\",\\n \\"ServiceName\\": \\"com.alibaba.xxx\\",\\n \\"Methods\\": [\\n {\\n \\"Paths\\": [\\n \\"/path\\"\\n ],\\n \\"ParameterTypes\\": [\\n \\"int\\"\\n ],\\n \\"RequestMethods\\": [\\n \\"sayHello\\"\\n ],\\n \\"Name\\": \\"sayHello\\",\\n \\"MethodController\\": \\"com.alibaba.SayHelloController\\",\\n \\"ReturnType\\": \\"int\\"\\n }\\n ],\\n \\"Metadata\\": {},\\n \\"Group\\": \\"dubbo\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetServiceList', + 'summary' => 'Queries the services of an application.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'GetServiceListPage' => [ + 'summary' => 'Retrieves a list of services.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17044', + 'abilityTreeNodes' => ['FEATUREmseXPQ6HT'], + ], + 'parameters' => [ [ - 'name' => 'MaxQueueingTimeMs', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '超时时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceMode', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '资源模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '', - ], - 'example' => '0', - 'enum' => [ - '0', - ], - ], + 'schema' => ['description' => 'The name of the MSE namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'ParamItem', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '参数描述项', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 100, 'title' => ''], ], [ - 'name' => 'MetricType', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'title' => '指标类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - ], - 'example' => '1', - 'enum' => [ - '1', - ], - ], + 'schema' => ['description' => 'The service type.', 'type' => 'string', 'required' => false, 'example' => 'springCloud', 'title' => ''], ], [ - 'name' => 'StatIntervalMs', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '统计间隔', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The service name.', 'type' => 'string', 'required' => false, 'example' => 'sc-A', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - 'WEB', - 'RPC', - ], - 'example' => '1', - 'enum' => [ - '0', - '1', - '2', - '4', - '3', - ], - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['description' => 'The IP address to query.', 'type' => 'string', 'required' => false, 'example' => '223.5.5.5', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values are `zh` for Chinese (default) and `en` for English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -24343,496 +15872,334 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx', 'title' => ''], 'Data' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'StatIntervalMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/flow', - ], - 'ControlBehavior' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ReourceMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hkhon1****@c3df23522******', - ], - 'MetricType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Burst' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParamItem' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + 'Result' => [ + 'title' => '', + 'description' => 'The list of services on the current page.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of each service.', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'example-app', 'title' => ''], + 'Version' => ['description' => 'The version of the service.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'InstanceNum' => ['description' => 'The number of nodes for the service.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GmtModifyTime' => ['description' => 'The time when the service was last updated.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'AppId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => 'sc-A', 'title' => ''], + 'Group' => ['description' => 'The service group.', 'type' => 'string', 'title' => '', 'example' => 'DEFAULT_GROUP'], + 'ServiceType' => ['description' => 'The type of the service.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'example' => '', ], + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'title' => ''], ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"AppName\\": \\"example-app\\",\\n \\"Version\\": \\"1\\",\\n \\"InstanceNum\\": 1,\\n \\"GmtModifyTime\\": \\"123456\\",\\n \\"AppId\\": \\"dez4xxxxx@f3f75ed8ffxxxxx\\",\\n \\"ServiceName\\": \\"sc-A\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"ServiceType\\": \\"\\"\\n }\\n ],\\n \\"TotalSize\\": \\"100\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetServiceListPage', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceListPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ControlBehavior\\": 0,\\n \\"ReourceMode\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1****@c3df23522******\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Burst\\": 0,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateWebFlowRule', ], - 'DeleteWebFlowRules' => [ - 'summary' => 'Deletes a hot parameter protection rule for HTTP requests.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetServiceListeners' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '164288', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '137871', + 'abilityTreeNodes' => ['FEATUREmseXDLQRG'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['title' => '', 'description' => 'The name of the service whose listeners you want to query.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zeekr-orderboss'], ], [ - 'name' => 'Ids', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[1, 2, 3]', - ], + 'schema' => ['title' => '', 'description' => 'The group to which the service belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WEB_GROUP'], ], [ - 'name' => 'AppName', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '', 'description' => 'The namespace to which the service belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b'], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the cluster to which the service belongs.'."\n" + ."\n" + .'> The cluster is a concept for Nacos services and is not equivalent to a Microservices Engine (MSE) instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], + ], + [ + 'name' => 'HasIpCount', + 'in' => 'query', + 'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'none'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the MSE instance to which the service belongs.'."\n" + ."\n" + .'> You must specify InstanceId or ClusterId.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the instance to which the service belongs.'."\n" + ."\n" + .'> You must specify InstanceId or ClusterId.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl32odtt20j'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RegCenterOperatorResult', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '354FF159-E9FB-5FBA-BDD5-E99EE440A88D', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '[1, 2, 3]', + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Addr' => ['title' => '', 'description' => 'The IP address of the listener.'."\n", 'type' => 'string', 'example' => '119.23.84.102'], + 'Agent' => ['title' => '', 'description' => 'The listener client version.'."\n", 'type' => 'string', 'example' => 'Nacos-Java-Client:v2.1.1'], + 'App' => ['title' => '', 'description' => 'The application name of the listener.'."\n", 'type' => 'string', 'example' => 'app'], + 'IP' => ['title' => '', 'description' => 'The IP address of the monitored service.'."\n", 'type' => 'string', 'example' => '172.16.1.5'], + 'Port' => ['title' => '', 'description' => 'The port number of the monitored service.'."\n", 'type' => 'string', 'example' => '8080'], + 'NamespaceId' => ['title' => '', 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => '0ba53825-b183-414f-a6a0-288e4f1c467e'], + 'ServiceName' => ['title' => '', 'description' => 'The name of the monitored service.'."\n", 'type' => 'string', 'example' => 'zeekr-orderboss'], + 'Cluster' => ['title' => '', 'description' => 'The name of the cluster to which the monitored service belongs.'."\n", 'type' => 'string', 'example' => 'DEFAULT'], + ], ], ], + 'PageNumber' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['title' => '', 'description' => 'The number of listeners that are queried.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Addr\\": \\"119.23.84.102\\",\\n \\"Agent\\": \\"Nacos-Java-Client:v2.1.1\\",\\n \\"App\\": \\"app\\",\\n \\"IP\\": \\"172.16.1.5\\",\\n \\"Port\\": \\"8080\\",\\n \\"NamespaceId\\": \\"0ba53825-b183-414f-a6a0-288e4f1c467e\\",\\n \\"ServiceName\\": \\"zeekr-orderboss\\",\\n \\"Cluster\\": \\"DEFAULT\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\"\\n}","type":"json"}]', + 'title' => 'GetServiceListeners', + 'summary' => 'Queries the list of listeners for the destination service.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceListeners', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"354FF159-E9FB-5FBA-BDD5-E99EE440A88D\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 0\\n ]\\n}","type":"json"}]', - 'title' => 'DeleteWebFlowRules', ], - 'UpdateWebFlowRule' => [ - 'summary' => 'Updates a hot parameter protection rule for HTTP requests.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetServiceMethodPage' => [ + 'summary' => 'Queries a list of service interfaces.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '164287', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - 'default' => 'default', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'The engine type.', 'type' => 'string', 'required' => false, 'example' => 'springCloud', 'title' => ''], ], [ - 'name' => 'Threshold', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The Microservices Engine (MSE) namespace to which the application belongs.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'Enable', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'example-app', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'Burst', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'hkhonxxxxx@f3f75ed8ffxxxxx', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1****@c3df23522******', - ], + 'schema' => ['description' => 'The name of the service.', 'type' => 'string', 'required' => false, 'example' => 'sc-A', 'title' => ''], ], [ - 'name' => 'ControlBehavior', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1.0.0'], ], [ - 'name' => 'MaxQueueingTimeMs', + 'name' => 'ServiceGroup', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => 'The group to which the service belongs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ALIYUN'], ], [ - 'name' => 'ResourceMode', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The IP address of the service provider.', 'type' => 'string', 'required' => false, 'example' => '223.5.5.5', 'title' => ''], ], [ - 'name' => 'ParamItem', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"fieldName":"key","matchStrategy":2,"parseStrategy":2,"pattern":"value"}', - ], + 'schema' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65536', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'MetricType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65536', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'StatIntervalMs', + 'name' => 'MethodController', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The full name of the Controller class to which the interface belongs.', 'type' => 'string', 'required' => false, 'example' => 'com.alibabacloud.mse.demo.a.AController', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The request path that corresponds to the interface.', 'type' => 'string', 'required' => false, 'example' => '/a', 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The method name.', 'type' => 'string', 'required' => false, 'example' => 'aMethod', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -24840,161 +16207,221 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'Message' => ['description' => 'The request information.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1', 'title' => ''], 'Data' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response to the request.', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'StatIntervalMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/flow', - ], - 'ControlBehavior' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ReourceMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hkhon1XXXX@54e1f42f37cXXXX', - ], - 'MetricType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Burst' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParamItem' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + 'Result' => [ + 'title' => '', + 'description' => 'The method description list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The description of each method.', + 'type' => 'object', + 'properties' => [ + 'NameDetail' => ['description' => 'The interface description information.', 'type' => 'string', 'example' => 'sample description', 'title' => ''], + 'ParameterDetails' => [ + 'title' => '', + 'description' => 'The type of the interface parameter.', + 'type' => 'array', + 'items' => ['description' => 'The type of each parameter.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + 'example' => '', + ], + 'ParameterDefinitions' => [ + 'title' => '', + 'description' => 'The detailed definition of the parameter.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The detailed definition of the parameter.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The parameter type.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + 'Description' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'sample description', 'title' => ''], + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'aParam', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Paths' => [ + 'title' => '', + 'description' => 'The list of request paths that correspond to the interface.', + 'type' => 'array', + 'items' => ['description' => 'The request path that corresponds to the interface.', 'type' => 'string', 'example' => '/a', 'title' => ''], + 'example' => '', + ], + 'ParameterTypes' => [ + 'title' => '', + 'description' => 'The parameter types.', + 'type' => 'array', + 'items' => ['description' => 'The parameter type.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + 'example' => '', + ], + 'RequestMethods' => [ + 'title' => '', + 'description' => 'The HTTP request method.', + 'type' => 'array', + 'items' => ['description' => 'The HTTP request parameter.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'example' => '', + ], + 'ReturnDetails' => ['description' => 'The type of the return value.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + 'Name' => ['description' => 'The name of the method.', 'type' => 'string', 'example' => 'aMethod', 'title' => ''], + 'MethodController' => ['description' => 'The full name of the Controller class to which the interface belongs.', 'type' => 'string', 'example' => 'com.alibabacloud.mse.demo.a.AController', 'title' => ''], + 'ReturnType' => ['description' => 'The type of the return value.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', ], + 'TotalSize' => ['description' => 'The total number of methods.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"NameDetail\\": \\"sample description\\",\\n \\"ParameterDetails\\": [\\n \\"java.lang.String\\"\\n ],\\n \\"ParameterDefinitions\\": [\\n {\\n \\"Type\\": \\"java.lang.String\\",\\n \\"Description\\": \\"sample description\\",\\n \\"Name\\": \\"aParam\\"\\n }\\n ],\\n \\"Paths\\": [\\n \\"/a\\"\\n ],\\n \\"ParameterTypes\\": [\\n \\"java.lang.String\\"\\n ],\\n \\"RequestMethods\\": [\\n \\"GET\\"\\n ],\\n \\"ReturnDetails\\": \\"java.lang.String\\",\\n \\"Name\\": \\"aMethod\\",\\n \\"MethodController\\": \\"com.alibabacloud.mse.demo.a.AController\\",\\n \\"ReturnType\\": \\"java.lang.String\\"\\n }\\n ],\\n \\"TotalSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'GetServiceMethodPage', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceMethodPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ControlBehavior\\": 0,\\n \\"ReourceMode\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1XXXX@54e1f42f37cXXXX\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Burst\\": 0,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateWebFlowRule', ], - 'ListAuthPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'GetTagsBySwimmingLaneGroupId' => [ + 'summary' => 'Obtains all tags in the current lane group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the lane group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '154', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Data' => [ + 'description' => 'The data of the tag.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The data of the tag.'."\n", 'type' => 'string', 'example' => '[{"desc":"k8s-pod-label","priority":100,"tag":"gray","type":"tag"}]', 'title' => ''], + 'example' => '["gray"]', + 'title' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": [\\n \\"[{\\\\\\"desc\\\\\\":\\\\\\"k8s-pod-label\\\\\\",\\\\\\"priority\\\\\\":100,\\\\\\"tag\\\\\\":\\\\\\"gray\\\\\\",\\\\\\"type\\\\\\":\\\\\\"tag\\\\\\"}]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'GetTagsBySwimmingLaneGroupId', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetTagsBySwimmingLaneGroupId', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetZookeeperDataImportUrl' => [ + 'summary' => 'mse-200-105', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https', 'wss'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -25004,739 +16431,592 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '17061', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], + 'abilityTreeCode' => '146920', + 'abilityTreeNodes' => ['FEATUREmseBQYNCQ'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The type of the file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-zvp2xzzkk06', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zip', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'RestResult'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + 'title' => 'RestResult', + 'description' => 'The ID of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'string', 'example' => 'E4E2058F-C524-5C29-9BC7-5874EA8D7CE2', 'title' => ''], + 'Success' => ['description' => 'The status code. A value of 200 is returned if the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The error code returned if the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The message returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The request was successfully processed.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Data' => [ + 'description' => 'The URL that is used to upload the configuration file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The maximum size of a file that can be uploaded each time. Unit: MB.'."\n", 'type' => 'string', 'example' => 'http://xxxxxxxxx', 'title' => ''], + 'MaxSize' => ['description' => 'code', 'type' => 'string', 'example' => '250000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'edasmsc', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4E2058F-C524-5C29-9BC7-5874EA8D7CE2\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"You are not authorized to perform this operation.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\",\\n \\"MaxSize\\": \\"250000\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetZookeeperDataImportUrl', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetZookeeperDataImportUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ImportNacosConfig' => [ + 'summary' => 'Imports Nacos configurations as a file.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'Protocol', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '76157', + 'abilityTreeNodes' => ['FEATUREmseEPOTV0'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol type. Valid values:'."\n" - ."\n" - .'* **SPRING_CLOUD**'."\n" - .'* **DUBBO**'."\n" - .'* **istio**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SPRING_CLOUD', - ], + 'schema' => ['description' => 'The instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the authentication rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'auto-rule-**', - ], + 'schema' => ['description' => 'The namespace ID. Default value: public', 'type' => 'string', 'required' => false, 'example' => 'f5cdc80a-****-8094-282f5650fc00', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'Policy', 'in' => 'query', 'schema' => [ - 'description' => 'The application ID.'."\n", + 'description' => 'The policy.', + 'enumValueTitles' => ['ABORT' => 'ABORT', 'OVERWRITE' => 'OVERWRITE', 'SKIP' => 'SKIP'], 'type' => 'string', 'required' => false, - 'example' => 'jgy4cadmqo@***', + 'docRequired' => true, + 'example' => 'OVERWRITE', + 'title' => '', ], ], [ - 'name' => 'Namespace', + 'name' => 'FileUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The URL of the file that you want to import. This parameter must be set to the URL generated by Microservices Engine (MSE). Otherwise, error information is returned, indicating that the required permissions are not granted.'."\n" + .'Perform the following steps to obtain the URL:'."\n" + ."\n" + .'1\\. Call the GetImportFileUrl operation to obtain the URL.'."\n" + ."\n" + .'2\\. Use the HTTP PUT method to upload the file to the HTTP URL returned by the preceding step.'."\n" + ."\n" + .'3\\. Call the ImportNacosConfig operation to import Nacos configurations.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'http://mse-shared.oss-xxx.aliyuncs.com/cfg/import/xxxx/2021/01/11/xxxx.zip', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese and the value en-US indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '05A5A150-4A5F-5A8C-97D6-710776CC8408', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-100', 'title' => ''], + 'Code' => ['description' => 'The code.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Message' => ['description' => 'The message that is returned for the request.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic error message, used to replace the **%s** in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the **ErrMessage** returns **The Value of Input Parameter %s is not valid**, and **DynamicMessage** returns **DtsJobId**, it means that the request parameter **DtsJobId** is invalid.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The data returned.'."\n", + 'SuccCount' => ['description' => 'The number of configurations that are imported.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'SkipCount' => ['description' => 'The number of configurations that are skipped.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SkipData' => [ + 'description' => 'The information about skipped configurations.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AuthRule' => [ - 'description' => 'The content of the service authentication rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Black' => [ - 'description' => 'Indicates whether the rule is a blacklist rule.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Path' => [ - 'description' => 'The service path.'."\n", - 'type' => 'string', - 'example' => '/a', - ], - 'Method' => [ - 'description' => 'The request method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => 'The method version.'."\n", - 'type' => 'string', - 'example' => '0.0.1', - ], - 'ParameterTypes' => [ - 'description' => 'The types of request parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the request parameter.'."\n", - 'type' => 'string', - 'example' => '[\\"java.lang.String\\",\\"java.lang.Object\\",\\"java.lang.String\\"]', - ], - ], - 'ServiceName' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Name' => [ - 'description' => 'The method name.'."\n", - 'type' => 'string', - 'example' => 'hello', - ], - 'Group' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'ReturnType' => [ - 'description' => 'The type of the return value.'."\n", - 'type' => 'string', - 'example' => 'Boolean', - ], - ], - ], - 'AppIds' => [ - 'description' => 'The IDs of applications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '["dez4qt7weh@***"]', - ], - ], - 'AuthType' => [ - 'description' => 'The rule type. Valid values:'."\n" - ."\n" - .'* 0: by application'."\n" - .'* 1: by namespace'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'K8sNamespaces' => [ - 'description' => 'The queried namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'acced****', - ], - ], - ], - ], - ], - 'NamespaceId' => [ - 'description' => 'The namespace ID.'."\n", - 'type' => 'string', - 'example' => 'ced54a95-4e33-4bda-be7e-37e95868***', - ], - 'Protocol' => [ - 'description' => 'The protocol type. Valid values:'."\n" - ."\n" - .'* **SPRING_CLOUD**'."\n" - .'* **DUBBO**'."\n" - .'* **istio**'."\n", - 'type' => 'string', - 'example' => 'SPRING_CLOUD', - ], - 'AccountId' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the resource belongs.'."\n", - 'type' => 'string', - 'example' => '19039813784***', - ], - 'Source' => [ - 'description' => 'The source of the application.'."\n", - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@5f1b08becb*****', - ], - 'Name' => [ - 'description' => 'The name of the authentication rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204', - ], - 'Enable' => [ - 'description' => 'Indicates whether the rule was enabled or disabled. Valid values:'."\n" - ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AuthType' => [ - 'description' => 'The rule type. Valid values:'."\n" - ."\n" - .'* 0: by application'."\n" - .'* 1: by namespace'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'K8sNamespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', - ], + 'DataId' => ['description' => 'The ID of the data.', 'type' => 'string', 'example' => 'test.yaml', 'title' => ''], + 'Group' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'public ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalSize' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'FailData' => [ + 'description' => 'The information about configurations that are failed to be imported.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => 'The ID of the data.', 'type' => 'string', 'example' => 'test2.yaml', 'title' => ''], + 'Group' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Reason' => ['description' => 'The failure reason', 'type' => 'string', 'example' => 'The import configuration format is incorrect.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Code\\": 1,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"SuccCount\\": 100,\\n \\"SkipCount\\": 10,\\n \\"SkipData\\": [\\n {\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"public \\"\\n }\\n ],\\n \\"FailData\\": [\\n {\\n \\"DataId\\": \\"test2.yaml\\",\\n \\"Group\\": \\"test\\",\\n \\"Reason\\": \\"The import configuration format is incorrect.\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ImportNacosConfig', + 'description' => '> The current OpenAPI is not the Nacos-SDK API. For information about the Nacos-SDK API, see [Official Documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"05A5A150-4A5F-5A8C-97D6-710776CC8408\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Status\\": 1,\\n \\"AuthRule\\": [\\n {\\n \\"Black\\": false,\\n \\"Path\\": \\"/a\\",\\n \\"Method\\": {\\n \\"Version\\": \\"0.0.1\\",\\n \\"ParameterTypes\\": [\\n \\"[\\\\\\\\\\\\\\"java.lang.String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"java.lang.Object\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"java.lang.String\\\\\\\\\\\\\\"]\\"\\n ],\\n \\"ServiceName\\": \\"spring-cloud-a\\",\\n \\"Name\\": \\"hello\\",\\n \\"Group\\": \\"default\\",\\n \\"ReturnType\\": \\"Boolean\\"\\n },\\n \\"AppIds\\": [\\n \\"[\\\\\\"dez4qt7weh@***\\\\\\"]\\"\\n ],\\n \\"AuthType\\": 0,\\n \\"K8sNamespaces\\": [\\n \\"acced****\\"\\n ]\\n }\\n ],\\n \\"NamespaceId\\": \\"ced54a95-4e33-4bda-be7e-37e95868***\\",\\n \\"Protocol\\": \\"SPRING_CLOUD\\",\\n \\"AccountId\\": \\"19039813784***\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"Name\\": \\"test\\",\\n \\"Id\\": 204,\\n \\"Enable\\": false,\\n \\"AuthType\\": 0,\\n \\"K8sNamespace\\": \\"c19c6c500e1ff4d7abc7bed9b8236***\\"\\n }\\n ],\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ListAuthPolicy', - 'summary' => 'Queries a list of service authentication rules.', ], - 'UpdateAuthPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ImportServices' => [ + 'summary' => 'Subscribe to the services of the imported gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17097', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '25182', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'demo-test', - ], - ], - [ - 'name' => 'Source', + 'name' => 'ServiceList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The source for application access.'."\n", - 'type' => 'string', + 'description' => 'The service list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'public', 'title' => ''], + 'GroupName' => ['description' => 'The group name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Ips' => [ + 'description' => 'The list of IP addresses.', + 'type' => 'array', + 'items' => ['description' => 'An IP address.', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ServicePort' => ['description' => 'The service port.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '8080'], + 'ServiceProtocol' => ['description' => 'The service protocol.', 'type' => 'string', 'example' => 'GRPC, HTTP', 'title' => '', 'required' => false], + 'DnsServerList' => [ + 'type' => 'array', + 'items' => ['description' => 'A DNS server address, specified in the `IP:port` format.', 'type' => 'string', 'example' => '1.1.1.1:80', 'title' => '', 'required' => false], + 'title' => '', + 'required' => false, + 'description' => 'The list of DNS servers. This parameter is applicable only when `SourceType` is set to `DNS`.', + 'example' => '', + ], + 'SaeAppId' => ['description' => 'The SAE application ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'edasmsc', + 'example' => 'DNS', + 'title' => '', ], ], [ - 'name' => 'Id', + 'name' => 'SourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The rule ID.'."\n", + 'description' => 'The service source. Valid values: `MSE` (an MSE Nacos instance), `K8s` (an ACK container service), `VIP` (a fixed address), `DNS` (a DNS domain name), `EDAS` (an EDAS application), `SAE` (an SAE application), `FC` (a Function Compute service), and `MSE_ZK` (an MSE ZooKeeper instance).'."\n" + ."\n" + .'-'."\n" + ."\n" + .'-'."\n" + ."\n" + .'-'."\n" + ."\n" + .'-', + 'enumValueTitles' => ['EDAS' => 'EDAS', 'MSE_ZK' => 'MSE\\_ZK', 'SAE' => 'SAE', 'K8S' => 'K8S', 'DNS' => 'DNS', 'VIP' => 'VIP', 'MSE' => 'MSE'], 'type' => 'string', - 'required' => true, 'docRequired' => true, - 'example' => '432', + 'example' => 'DNS', + 'title' => '', + 'required' => true, ], ], [ - 'name' => 'Region', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'TlsSetting', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The TLS settings, specified as a JSON string. The following fields are supported:'."\n" + ."\n" + .'- `mode`: The TLS mode.'."\n" + ."\n" + .'- `certId`: The certificate ID.'."\n" + ."\n" + .'- `caCertId`: The CA certificate ID.'."\n" + ."\n" + .'- `caCertContent`: The public key of the CA certificate.'."\n" + ."\n" + .'- `sni`: The Server Name Indication (SNI).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mode": "MUTUAL",'."\n" + .' "certId": "1*****-cn-hangzhou",'."\n" + .' "caCertContent": "123",'."\n" + .' "sni": "ceshi"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'FcServiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcde@12345', - ], + 'schema' => ['description' => 'The name of the Function Compute (FC) service. This parameter is applicable only when `SourceType` is set to `FC`.', 'type' => 'string', 'required' => false, 'example' => 'guide', 'title' => ''], ], [ - 'name' => 'Protocol', + 'name' => 'FcVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol type. Valid values:'."\n" - ."\n" - .'* **SPRING_CLOUD**'."\n" - .'* **DUBBO**'."\n" - .'* **istio**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SPRING_CLOUD', - ], + 'schema' => ['description' => 'The version of the FC service. This parameter is applicable only when `SourceType` is set to `FC`.', 'type' => 'string', 'required' => false, 'example' => 'LATEST', 'title' => ''], ], [ - 'name' => 'AuthRule', + 'name' => 'FcAlias', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the service authentication rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"all\\":true,\\"appIds\\":[\\"f6xqzbao96@4adfaf3c92c947a\\"],\\"black\\":false}]', - ], + 'schema' => ['description' => 'The alias of the Function Compute (FC) service. This parameter is applicable only when `SourceType` is set to `FC`.', 'type' => 'string', 'required' => false, 'example' => 'test-alias', 'title' => ''], ], [ - 'name' => 'K8sNamespace', + 'name' => 'SourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACK cluster namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', - ], + 'schema' => ['description' => 'The ID of the service source from which services are imported.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- `zh`: Chinese'."\n" + ."\n" + .'- `en`: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83E3909D-D26F-5D97-B73B-407A26***', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Succ\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'ImportServices', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"83E3909D-D26F-5D97-B73B-407A26***\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"{}\\",\\n \\"Code\\": 500,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateAuthPolicy', - 'summary' => 'Updates a service authentication rule.', ], - 'AddAuthPolicy' => [ - 'summary' => 'Creates a service authentication rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ImportZookeeperData' => [ + 'summary' => 'Initiates a task to import data from a destination URL to a Microservices Engine (MSE) ZooKeeper instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '16988', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '146919', + 'abilityTreeNodes' => ['FEATUREmseBQYNCQ'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'FileUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'edasmsc', - ], + 'schema' => ['description' => 'The URL of the source data.'."\n" + ."\n" + .'> You must set this parameter to the URL that is generated by calling the GetZookeeperDataImportUrl operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://xxxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the file that you want to import.'."\n", 'type' => 'string', 'required' => false, 'example' => 'snapshot.5', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'e9clba2xlc@***', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Protocol', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SPRING_CLOUD', + 'title' => 'BaseResult', + 'description' => 'BaseResult'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'Data' => ['description' => 'The details of the data.'."\n", 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'AuthRule', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"all":true,"black":false,"appIds":["dez4qt7weh@***"]}]', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'ImportZookeeperData', + 'description' => '**Danger** This operation clears existing data. Exercise caution when you call this API operation.', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ImportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'InitializeServiceLinkRole' => [ + 'summary' => 'Creates a Microservices Engine (MSE) service-linked role.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['common'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17049', + 'abilityTreeNodes' => ['FEATUREmseRIJL6U'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'AuthType', + 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'This parameter is reserved and not in use.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], ], [ - 'name' => 'K8sNamespace', + 'name' => 'RoleName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c19c6c500e1ff4d7abc7***', - ], + 'schema' => ['description' => 'The name of the server-linked role. Set this parameter to AliyunServiceRoleForMSE', 'type' => 'string', 'required' => false, 'example' => 'AliyunServiceRoleForMSE', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -25744,120 +17024,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dc63-465d-8ef5-20dc18af****', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RoleName' => ['description' => 'The name of the created service-linked role.', 'type' => 'string', 'example' => 'AliyunServiceRoleForMSE', 'title' => ''], + 'RequiredPermission' => ['description' => 'The permission that is granted to the RAM user to call the API operation.', 'type' => 'string', 'example' => 'ram:CreateServiceLinkedRole', 'title' => ''], + 'ServiceName' => ['description' => 'The service to which the service-linked role belongs.', 'type' => 'string', 'example' => 'mse.aliyuncs.com', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX\\",\\n \\"Data\\": {\\n \\"RoleName\\": \\"AliyunServiceRoleForMSE\\",\\n \\"RequiredPermission\\": \\"ram:CreateServiceLinkedRole\\",\\n \\"ServiceName\\": \\"mse.aliyuncs.com\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'InitializeServiceLinkRole', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:InitializeServiceLinkRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"请求处理成功。\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AddAuthPolicy', ], - 'RemoveAuthPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAnsInstances' => [ + 'summary' => 'Queries application instances that are registered with a Microservices Engine (MSE) Nacos instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17087', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '17056', + 'abilityTreeNodes' => ['FEATUREmseAPH368'], ], 'parameters' => [ [ - 'name' => 'PolicyId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '259', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Nacos instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****', 'deprecated' => true, 'title' => ''], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the contact group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => '12233****', 'title' => ''], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['description' => 'The alias of the Nacos instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl327w****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -25865,89 +17162,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DefaultKey' => ['description' => 'The default key.'."\n", 'type' => 'string', 'example' => '30.5.XX.XX:unknown', 'title' => ''], + 'Ephemeral' => ['description' => 'Indicates whether the information about the ephemeral node is obtained. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Marked' => ['description' => 'Indicates whether the instance was marked. Valid values:'."\n" + ."\n" + .'* `true`: The instance marking was successful.'."\n" + .'* `false`: The instance marking failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Ip' => ['description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => '30.5.XX.XX', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => '30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService', 'title' => ''], + 'Port' => ['description' => 'The port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'LastBeat' => ['description' => 'The last heartbeat time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20201010', 'title' => ''], + 'OkCount' => ['description' => 'The number of counted successes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Weight' => ['description' => 'The weight.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'InstanceHeartBeatInterval' => ['description' => 'The heartbeat interval of the instance. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5000', 'title' => ''], + 'IpDeleteTimeout' => ['description' => 'The timeout period for removing an IP address.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30000', 'title' => ''], + 'App' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'app', 'title' => ''], + 'FailCount' => ['description' => 'The number of counted failures.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Healthy' => ['description' => 'The health status of the instance. Valid values:'."\n" + ."\n" + .'* `true`: The instance is healthy.'."\n" + .'* `false`: The instance is unhealthy.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Enabled' => ['description' => 'The effective status of the instance. Valid values:'."\n" + ."\n" + .'* `true`: The instance takes effect.'."\n" + .'* `false`: The instance does not take effect.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DatumKey' => ['description' => 'The reference key.'."\n", 'type' => 'string', 'example' => '30.5.XX.XX:unknown:DEFAULT', 'title' => ''], + 'ClusterName' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'InstanceHeartBeatTimeOut' => ['description' => 'The timeout period of the instance heartbeat.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15000', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::', 'title' => ''], + 'Metadata' => ['description' => 'The metadata.'."\n", 'type' => 'object', 'example' => '[int]', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"DefaultKey\\": \\"30.5.XX.XX:unknown\\",\\n \\"Ephemeral\\": true,\\n \\"Marked\\": true,\\n \\"Ip\\": \\"30.5.XX.XX\\",\\n \\"InstanceId\\": \\"30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService\\",\\n \\"Port\\": 8080,\\n \\"LastBeat\\": 20201010,\\n \\"OkCount\\": 0,\\n \\"Weight\\": 1,\\n \\"InstanceHeartBeatInterval\\": 5000,\\n \\"IpDeleteTimeout\\": 30000,\\n \\"App\\": \\"app\\",\\n \\"FailCount\\": 0,\\n \\"Healthy\\": true,\\n \\"Enabled\\": true,\\n \\"DatumKey\\": \\"30.5.XX.XX:unknown:DEFAULT\\",\\n \\"ClusterName\\": \\"DEFAULT\\",\\n \\"InstanceHeartBeatTimeOut\\": 15000,\\n \\"ServiceName\\": \\"DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::\\",\\n \\"Metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListAnsInstances', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9515ACA4-E94D-440D-989E-C379FCED****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": 500,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RemoveAuthPolicy', - 'summary' => 'Deletes a service authentication rule.', ], - 'GetServiceMethodPage' => [ - 'summary' => 'Queries a list of service interfaces.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListAnsServiceClusters' => [ + 'summary' => 'Queries the clusters of a Nacos service.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -25956,688 +17275,480 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17057', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ServiceType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '服务类型。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'springCloud', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间。', - 'type' => 'string', - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The ID of the MSE cluster.'."\n" + ."\n" + .'> The MSE cluster is different from the cluster of the Nacos service.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mse-09k1xxxx', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The name of the service.', 'type' => 'string', 'required' => false, 'example' => 'nacos.test.3', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '应用id。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhonxxxxx@f3f75ed8ffxxxxx', - ], + 'schema' => ['description' => 'The name of the group.', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP', 'title' => ''], ], [ - 'name' => 'ServiceName', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '服务名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sc-A', - ], + 'schema' => ['description' => 'The ID of the namespace.', 'type' => 'string', 'required' => false, 'example' => '12233****', 'title' => ''], ], [ - 'name' => 'ServiceVersion', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => '服务版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], + 'schema' => ['description' => 'The alias of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'qewr', 'title' => ''], ], [ - 'name' => 'ServiceGroup', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '服务分组。', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl32a6****', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '服务提供者ip。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '223.5.5.5', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'ProtectThreshold' => ['description' => 'The protection threshold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'GroupName' => ['description' => 'The service group to which the service belongs.', 'type' => 'string', 'example' => 'DEFAULT_GROUP', 'title' => ''], + 'Clusters' => [ + 'description' => 'The cluster information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'DefaultCheckPort' => ['description' => 'The default port used for a health check.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'HealthCheckerType' => ['description' => 'The type of the health check.', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'UseIPPort4Check' => ['description' => 'Indicates whether an end-to-end health check was initiated by the server. This parameter is valid only if the service is not a temporary service.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ServiceName' => ['description' => 'The full name of the service.', 'type' => 'string', 'example' => 'DEFAULT_GROUP@@nacos.test.3', 'title' => ''], + 'Name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DefaultPort' => ['description' => 'The default port.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'Metadata' => ['description' => 'The metadata of the cluster.', 'type' => 'object', 'example' => '111', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => 'nacos.test.3', 'title' => ''], + 'SelectorType' => ['description' => 'The election mode.', 'type' => 'string', 'example' => 'none', 'title' => ''], + 'Metadata' => ['description' => 'The metadata of the service.', 'type' => 'object', 'example' => '111', 'title' => ''], + 'Ephemeral' => ['description' => 'Indicates whether the service is a temporary service. Valid values:'."\n" + ."\n" + .'- `true`: yes'."\n" + ."\n" + .'- `false`: no', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Source' => ['description' => 'The source type of the service. Valid values:'."\n" + ."\n" + .'- console: The service was registered in the console.'."\n" + ."\n" + .'- sdk: The service was registered by using the SDK.'."\n" + ."\n" + .'- governance: The service was registered on Microservices Governance.', 'type' => 'string', 'example' => 'console', 'title' => ''], + 'AppDetail' => [ + 'description' => 'The information about the associated application for which Microservices Governance is enabled when the Source parameter is set to governance.', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => 'The ID of the application for which Microservices Governance is enabled.', 'type' => 'string', 'example' => 'hkhon1po62@904cba2c0xxxxxx', 'title' => ''], + 'AppName' => ['description' => 'The name of the application for which Microservices Governance is enabled.', 'type' => 'string', 'example' => 'spring-cloud-b', 'title' => ''], + 'Port' => ['description' => 'The port number of the application for which Microservices Governance is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '6001', 'title' => ''], + 'CheckType' => ['description' => 'The type of the health check. Valid values:'."\n" + ."\n" + .'- connection: connection status check'."\n" + ."\n" + .'- tcp: TCP connection check'."\n" + ."\n" + .'- http: HTTP connection check', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'CheckPath' => ['description' => 'The path of the health check. This parameter is required only when the CheckType parameter is set to http.', 'type' => 'string', 'example' => '/health', 'title' => ''], + 'CheckTimeout' => ['description' => 'The timeout period of the health check response. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'CheckInternal' => ['description' => 'The health check interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'HealthyCheckTimes' => ['description' => 'The maximum number of health check retries when the instance state changes from unhealthy to healthy.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'UnhealthyCheckTimes' => ['description' => 'The maximum number of health check retries when the instance state changes from healthy to unhealthy.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '获取第几页的数据。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '65536', - 'minimum' => '1', - 'example' => '1', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": {\\n \\"ProtectThreshold\\": 0,\\n \\"GroupName\\": \\"DEFAULT_GROUP\\",\\n \\"Clusters\\": [\\n {\\n \\"DefaultCheckPort\\": 80,\\n \\"HealthCheckerType\\": \\"tcp\\",\\n \\"UseIPPort4Check\\": true,\\n \\"ServiceName\\": \\"DEFAULT_GROUP@@nacos.test.3\\",\\n \\"Name\\": \\"test\\",\\n \\"DefaultPort\\": 80,\\n \\"Metadata\\": 111\\n }\\n ],\\n \\"Name\\": \\"nacos.test.3\\",\\n \\"SelectorType\\": \\"none\\",\\n \\"Metadata\\": 111,\\n \\"Ephemeral\\": true,\\n \\"Source\\": \\"console\\",\\n \\"AppDetail\\": {\\n \\"AppId\\": \\"hkhon1po62@904cba2c0xxxxxx\\",\\n \\"AppName\\": \\"spring-cloud-b\\",\\n \\"Port\\": 6001,\\n \\"CheckType\\": \\"tcp\\",\\n \\"CheckPath\\": \\"/health\\",\\n \\"CheckTimeout\\": 5,\\n \\"CheckInternal\\": 2,\\n \\"HealthyCheckTimes\\": 2,\\n \\"UnhealthyCheckTimes\\": 2\\n }\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'ListAnsServiceClusters', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsServiceClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'ListAnsServices' => [ + 'summary' => 'Queries the details of Nacos services.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17058', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '每一页多少条。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '65536', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the service.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'name'], ], [ - 'name' => 'MethodController', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '接口所在的Controller类全称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'com.alibabacloud.mse.demo.a.AController', - ], + 'schema' => ['description' => 'The name of the contact group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'name'], ], [ - 'name' => 'Path', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '接口对应的请求路径。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], + 'schema' => ['description' => 'The ID of the namespace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '12233****'], ], [ - 'name' => 'Name', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => '方法名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aMethod', - ], + 'schema' => ['title' => '查询服务下某个集群的实例列表是所需要的参数', 'description' => 'The parameter that is required to query the list of instances in a specific cluster of a service.', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'HasIpCount', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', + 'description' => 'Specifies whether to query the number of service instances.', + 'enumValueTitles' => ['false' => '不需要', 'true' => '需要'], 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'example' => 'true', + 'title' => '', ], ], - ], - 'responses' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You must specify either this parameter or InstanceId.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You must specify either this parameter or ClusterId.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'mse-cn-st21v5****'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of instances to display on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '10'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '请求是否成功。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '', - 'type' => 'string', - 'example' => '2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1', - ], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of instances displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ - 'title' => '请求响应数据。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'title' => '方法描述列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '每个方法描述。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NameDetail' => [ - 'title' => '接口描述信息。', - 'description' => '', - 'type' => 'string', - 'example' => '示例接口描述信息。', - ], - 'ParameterDetails' => [ - 'title' => '接口参数类型。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '每个参数的类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - ], - 'ParameterDefinitions' => [ - 'title' => '参数的详细定义。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '参数的详细定义。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '参数类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - 'Description' => [ - 'title' => '参数描述。', - 'description' => '', - 'type' => 'string', - 'example' => '参数描述示例', - ], - 'Name' => [ - 'title' => '参数名字。', - 'description' => '', - 'type' => 'string', - 'example' => 'aParam', - ], - ], - ], - ], - 'Paths' => [ - 'title' => '接口对应的请求路径列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '接口对应的请求路径。', - 'description' => '', - 'type' => 'string', - 'example' => '/a', - ], - ], - 'ParameterTypes' => [ - 'title' => '参数类型。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '参数类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - ], - 'RequestMethods' => [ - 'title' => 'HTTP请求方法。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'HTTP请求参数。', - 'description' => '', - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'ReturnDetails' => [ - 'title' => '返回值类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - 'Name' => [ - 'title' => '方法名。', - 'description' => '', - 'type' => 'string', - 'example' => 'aMethod', - ], - 'MethodController' => [ - 'title' => '接口所在的Controller类全称。', - 'description' => '', - 'type' => 'string', - 'example' => 'com.alibabacloud.mse.demo.a.AController', - ], - 'ReturnType' => [ - 'title' => '返回值类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - ], - ], - ], - 'TotalSize' => [ - 'title' => '方法总数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '第几页。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'description' => 'The data overview.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'HealthyInstanceCount' => ['description' => 'The total number of service instances with healthy heartbeats.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GroupName' => ['description' => 'The name of the contact group.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'IpCount' => ['description' => 'The total number of instances of the current service.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'ClusterCount' => ['description' => 'The total number of clusters.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Source' => ['description' => 'The type of the service. Valid values:'."\n" + ."\n" + .'- console: registered on the console.'."\n" + ."\n" + .'- sdk: registered using an SDK.'."\n" + ."\n" + .'- governance: registered using service administration.', 'type' => 'string', 'example' => 'console', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'The result of the request. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'OperationNotSupport', 'errorMessage' => 'The current cluster does not support this operation, %s.', 'description' => 'The current cluster does not support this operation, %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"HealthyInstanceCount\\": 1,\\n \\"GroupName\\": \\"name\\",\\n \\"IpCount\\": 1,\\n \\"Name\\": \\"name\\",\\n \\"ClusterCount\\": 1,\\n \\"Source\\": \\"console\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListAnsServices', + 'description' => '> This OpenAPI is not a Nacos SDK API. For more information about Nacos SDK APIs, see [the official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"NameDetail\\": \\"示例接口描述信息。\\",\\n \\"ParameterDetails\\": [\\n \\"java.lang.String\\"\\n ],\\n \\"ParameterDefinitions\\": [\\n {\\n \\"Type\\": \\"java.lang.String\\",\\n \\"Description\\": \\"参数描述示例\\",\\n \\"Name\\": \\"aParam\\"\\n }\\n ],\\n \\"Paths\\": [\\n \\"/a\\"\\n ],\\n \\"ParameterTypes\\": [\\n \\"java.lang.String\\"\\n ],\\n \\"RequestMethods\\": [\\n \\"GET\\"\\n ],\\n \\"ReturnDetails\\": \\"java.lang.String\\",\\n \\"Name\\": \\"aMethod\\",\\n \\"MethodController\\": \\"com.alibabacloud.mse.demo.a.AController\\",\\n \\"ReturnType\\": \\"java.lang.String\\"\\n }\\n ],\\n \\"TotalSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'GetServiceMethodPage', + 'translator' => 'manual', ], - 'GetServiceListPage' => [ - 'summary' => 'Queries the version of a microservices application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListAppBySwimmingLaneGroupTag' => [ + 'summary' => 'Queries the applications in a lane group by tag.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17044', - 'abilityTreeNodes' => [ - 'FEATUREmseXPQ6HT', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'title' => '地域。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the MSE namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名字。', - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 100, - ], - ], - [ - 'name' => 'ServiceType', - 'in' => 'query', - 'schema' => [ - 'title' => '服务类型。', - 'description' => 'The service type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'springCloud', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用id。', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', - ], - ], - [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'title' => '服务名字。', - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sc-A', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'Tag', 'in' => 'query', - 'schema' => [ - 'title' => '页数。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gray'], ], [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the lane group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '119'], ], [ - 'name' => 'Ip', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '要查询的ip地址。', - 'description' => 'The IP address from which the query is initiated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '223.5.5.5', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '请求是否成功。', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => 'The request information.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求id。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx', - ], - 'Data' => [ - 'title' => '请求响应数据。', - 'description' => 'The response to the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'title' => '当前页面数据。', - 'description' => 'The data on the current page.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '每个服务的信息。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => '应用名。', - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'example-app', - ], - 'Version' => [ - 'title' => '服务版本。', - 'description' => 'The service version.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'InstanceNum' => [ - 'title' => '服务对应的节点数。', - 'description' => 'The number of service nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtModifyTime' => [ - 'title' => '服务最后的更新时间。', - 'description' => 'The time when the service was last updated.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'AppId' => [ - 'title' => '应用id。', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', - ], - 'ServiceName' => [ - 'title' => '服务名。', - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'sc-A', - ], - 'Group' => [ - 'title' => '服务分组。', - 'description' => 'The group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'ServiceType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TotalSize' => [ - 'title' => '数据总数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '当前页码。', - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页面大小。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Data' => ['description' => 'The details of the data.'."\n", 'type' => 'any', 'example' => '[{appName:"test",appId:"hkhon1po62@958bba95910341f'."\n" + .'"}]', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], 'staticInfo' => [ + 'substitutions' => ['mse::2019-05-31::ListAppBySwimmingLaneGroupTags'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"AppName\\": \\"example-app\\",\\n \\"Version\\": \\"1\\",\\n \\"InstanceNum\\": 1,\\n \\"GmtModifyTime\\": \\"123456\\",\\n \\"AppId\\": \\"dez4xxxxx@f3f75ed8ffxxxxx\\",\\n \\"ServiceName\\": \\"sc-A\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"ServiceType\\": \\"\\"\\n }\\n ],\\n \\"TotalSize\\": \\"100\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetServiceListPage', - ], - 'GetServiceList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": \\"[{appName:\\\\\\"test\\\\\\",appId:\\\\\\"hkhon1po62@958bba95910341f\\\\n\\\\\\"}]\\"\\n}","type":"json"}]', + 'title' => 'ListAppBySwimmingLaneGroupTag', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTag', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAppBySwimmingLaneGroupTags' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -26645,1637 +17756,1242 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17043', - 'abilityTreeNodes' => [ - 'FEATUREmseW9QIF2', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou', - ], - ], - [ - 'name' => 'ServiceType', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The type of the framework.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The tag based on which you want to list applications.'."\n", + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The tag based on which you want to list applications.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gray'], 'required' => false, - 'example' => 'dubbo', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xxx@xxx', ], ], [ - 'name' => 'ServiceName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'com.alibaba.xxx', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the lane group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Ip', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the MSE namespace that you want to query.'."\n", 'type' => 'string', 'required' => true, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6832e76b-bb5f-4dea-****-************'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n", 'type' => 'boolean', 'example' => 'True'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Success'], + 'Message' => ['title' => '', 'description' => 'The additional request information.'."\n", 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'EdasAppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DubboApplicationName' => [ - 'description' => 'The name of the Dubbo application.'."\n", - 'type' => 'string', - 'example' => 'dubbo-application', - ], - 'Version' => [ - 'description' => 'The version information.'."\n", - 'type' => 'string', - 'example' => '1.0.0', - ], - 'SpringApplicationName' => [ - 'description' => 'The name of the Spring application.'."\n", - 'type' => 'string', - 'example' => 'spring-application', - ], - 'RegistryType' => [ - 'description' => 'The type of the service registry.'."\n", - 'type' => 'string', - 'example' => 'nacos', - ], - 'ServiceType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'dubbo', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'com.alibaba.xxx', - ], - 'Methods' => [ - 'description' => 'The methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The methods.'."\n", - 'type' => 'object', - 'properties' => [ - 'Paths' => [ - 'description' => 'The paths.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The path of the service.'."\n", - 'type' => 'string', - 'example' => '/path', - ], - ], - 'ParameterTypes' => [ - 'description' => 'The data types of the parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data type of the parameter.'."\n", - 'type' => 'string', - 'example' => 'int', - ], - ], - 'RequestMethods' => [ - 'description' => 'The methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method.'."\n", - 'type' => 'string', - 'example' => 'sayHello', - ], - ], - 'Name' => [ - 'description' => 'The name of the method.'."\n", - 'type' => 'string', - 'example' => 'sayHello', - ], - 'MethodController' => [ - 'description' => 'The controller of the method.'."\n", - 'type' => 'string', - 'example' => 'com.alibaba.SayHelloController', - ], - 'ReturnType' => [ - 'description' => 'The type of the return value.'."\n", - 'type' => 'string', - 'example' => 'int', - ], - ], - ], - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'Group' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'example' => 'dubbo', + 'title' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '', + 'description' => 'The returned information.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'type' => 'string', 'example' => '12345', 'description' => 'The ID of the user to which the application belongs.'."\n"], + 'RegionId' => ['title' => '', 'type' => 'string', 'example' => 'cn-hangzhou', 'description' => 'The region where the application resides.'."\n"], + 'Namespace' => ['title' => '', 'type' => 'string', 'example' => 'default', 'description' => 'The microservice namespace where the application resides.'."\n"], + 'AppName' => ['title' => '', 'type' => 'string', 'example' => 'example-app-name', 'description' => 'The application name.'."\n"], + 'AppId' => ['title' => '', 'type' => 'string', 'example' => '123456abcde@12345abcde', 'description' => 'The application ID.'."\n"], ], ], ], ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6832e76b-bb5f-4dea-****-************\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"key\\": [\\n {\\n \\"UserId\\": \\"12345\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"example-app-name\\",\\n \\"AppId\\": \\"123456abcde@12345abcde\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListAppBySwimmingLaneGroupTags', + 'summary' => 'Lists applications by tag in a specified lane group.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": [\\n {\\n \\"EdasAppName\\": \\"test\\",\\n \\"DubboApplicationName\\": \\"dubbo-application\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"SpringApplicationName\\": \\"spring-application\\",\\n \\"RegistryType\\": \\"nacos\\",\\n \\"ServiceType\\": \\"dubbo\\",\\n \\"ServiceName\\": \\"com.alibaba.xxx\\",\\n \\"Methods\\": [\\n {\\n \\"Paths\\": [\\n \\"/path\\"\\n ],\\n \\"ParameterTypes\\": [\\n \\"int\\"\\n ],\\n \\"RequestMethods\\": [\\n \\"sayHello\\"\\n ],\\n \\"Name\\": \\"sayHello\\",\\n \\"MethodController\\": \\"com.alibaba.SayHelloController\\",\\n \\"ReturnType\\": \\"int\\"\\n }\\n ],\\n \\"Metadata\\": {},\\n \\"Group\\": \\"dubbo\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetServiceList', - 'summary' => 'Queries the services of an application.', ], - 'CreateOrUpdateSwimmingLaneGroup' => [ - 'summary' => 'Creates or updates a lane group for end-to-end canary release.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListApplicationsWithTagRules' => [ + 'summary' => 'Queries the routing rules of an application.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'abilityTreeCode' => '116107', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '泳道组ID。-1时为创建泳道组，大于0时为修改指定泳道组。', - 'description' => 'The ID of the lane group. A value of -1 is used to create a lane group. A value greater than 0 is used to modify the specified lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The region of the gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'group1', - ], + 'schema' => ['description' => 'The data source. Default value: edasmsc.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'edasmsc', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '0 未生效', - 'description' => 'The status of the lane group. The value 0 specifies that the lane group is disabled. The value 1 specifies that the lane group is enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'xjpc0h9h4d@xxx', 'title' => ''], ], [ - 'name' => 'EntryApp', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '入口应用。格式 "来源系统:id"。比如：'."\n" - .'- mse:${mse应用id}'."\n" - .'- mse-gw:${mse云原生网关id}', - 'description' => 'The ingress application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Ingress', - ], + 'schema' => ['title' => '应用所属的MSE命名空间', 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'default' => 'default', 'required' => false], ], [ - 'name' => 'AppIds', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '应用集合。以 "," 分割应用 id', - 'description' => 'The IDs of applications. Separate application IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522baa898,hkhon1po62@66e5235415730a5,hkhon1po62@958bba95910341f', - ], + 'schema' => ['title' => '应用名字', 'description' => 'The name of the application.', 'type' => 'string', 'docRequired' => true, 'example' => 'test', 'maxLength' => 64, 'required' => true], ], [ - 'name' => 'MessageQueueGrayEnable', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否开启消息灰度', - 'description' => 'Specifies whether to enable canary release for messaging.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.'."\n" + ."\n" + .'- If the request is successful, a success message is returned.'."\n" + ."\n" + .'- If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The data structure.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的MSE命名空间', 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.', 'type' => 'string', 'example' => 'default'], + 'AppName' => ['title' => '应用名', 'description' => 'The application name.', 'type' => 'string', 'example' => 'service-lottery-core'], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'daqijp6c31@xxx', 'title' => ''], + 'RouteRules' => [ + 'description' => 'The rule list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule list.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Rate' => ['title' => '比例规则，20% 的流量路由到该标签对应的节点。', 'description' => 'The rate.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Enable' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Tag' => ['title' => '标签名。', 'description' => 'The tag.', 'type' => 'string', 'example' => 'gray'], + 'Name' => ['title' => '路由规则名称。', 'description' => 'The name of the rule.', 'type' => 'string', 'example' => 'dubbo'], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '653', 'title' => ''], + 'InstanceNum' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Rules' => [ + 'description' => 'The details of the routing rule.', + 'type' => 'object', + 'properties' => [ + 'springcloud' => [ + 'title' => 'springcloud规则。', + 'description' => 'The springcloud rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'condition' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'restItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'datum' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'nameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'cond' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'divisor' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'remainder' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'rate' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'triggerPolicy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'enable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'appId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'paths' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'path' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'dubbo' => [ + 'title' => 'dubbo 规则。', + 'description' => 'The rules of the Dubbo service.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'triggerPolicy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'serviceName' => ['title' => '服务名（接口）。', 'description' => 'The service name (interface).', 'type' => 'string', 'example' => ''], + 'group' => ['title' => 'dubbo服务分组。', 'description' => 'The Dubbo service group.', 'type' => 'string', 'example' => ''], + 'version' => ['title' => 'dubbo服务版本。', 'description' => 'The Dubbo service version.', 'type' => 'string', 'example' => ''], + 'methodName' => ['title' => 'dubbo服务方法名。', 'description' => 'The Dubbo service method name.', 'type' => 'string', 'example' => ''], + 'paramTypes' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'condition' => ['title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'description' => 'The logical operation relationships. Valid values: AND and OR.', 'type' => 'string', 'example' => ''], + 'argumentItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'operator' => ['title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', 'description' => 'The operator. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist.', 'type' => 'string', 'example' => ''], + 'nameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'datum' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'cond' => ['title' => '比较符号，可取 >=, <=, >, <, == 。', 'description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.', 'type' => 'string', 'example' => ''], + 'divisor' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'remainder' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'rate' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'index' => ['title' => '参数位置，从0开始。', 'description' => 'The parameter position, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'expr' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '{'."\n" + .' "dubbo": [{'."\n" + .' "serviceName": "com.taobao.hsf.common.DemoService",'."\n" + .' "group": "",'."\n" + .' "version": "",'."\n" + .' "methodName": "sayHello",'."\n" + .' "condition": "AND",'."\n" + .' "argumentItems": [{'."\n" + .' "index": 0,'."\n" + .' "expr": "",'."\n" + .' "operator": "rawvalue",'."\n" + .' "value": "jim",'."\n" + .' "cond": "=="'."\n" + .' }]'."\n" + .' }]'."\n" + .' }', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RouteStatus' => ['description' => 'The route state. Valid values:'."\n" + ."\n" + .'- 0: disabled'."\n" + ."\n" + .'- 1: enabled', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'true', - 'default' => 'false', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'MessageQueueFilterSide', - 'in' => 'query', - 'schema' => [ - 'title' => '消息灰度过滤侧', - 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Server', - 'default' => 'Server', - 'enum' => [ - 'Server', - 'Client', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"service-lottery-core\\",\\n \\"AppId\\": \\"daqijp6c31@xxx\\",\\n \\"RouteRules\\": [\\n {\\n \\"Status\\": 1,\\n \\"Rate\\": 10,\\n \\"Enable\\": true,\\n \\"Tag\\": \\"gray\\",\\n \\"Name\\": \\"dubbo\\",\\n \\"Id\\": 653,\\n \\"InstanceNum\\": 1,\\n \\"Rules\\": {\\n \\"springcloud\\": [\\n {\\n \\"condition\\": \\"\\",\\n \\"restItems\\": [\\n {\\n \\"datum\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"nameList\\": [\\n \\"\\"\\n ],\\n \\"cond\\": \\"\\",\\n \\"divisor\\": 0,\\n \\"remainder\\": 0,\\n \\"rate\\": 0,\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"triggerPolicy\\": \\"\\",\\n \\"enable\\": false,\\n \\"appId\\": \\"\\",\\n \\"priority\\": 0,\\n \\"tags\\": [\\n \\"\\"\\n ],\\n \\"paths\\": [\\n \\"\\"\\n ],\\n \\"path\\": \\"\\"\\n }\\n ],\\n \\"dubbo\\": [\\n {\\n \\"appId\\": \\"\\",\\n \\"tags\\": [\\n \\"\\"\\n ],\\n \\"triggerPolicy\\": \\"\\",\\n \\"serviceName\\": \\"\\",\\n \\"group\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"methodName\\": \\"\\",\\n \\"paramTypes\\": [\\n \\"\\"\\n ],\\n \\"condition\\": \\"\\",\\n \\"argumentItems\\": [\\n {\\n \\"operator\\": \\"\\",\\n \\"nameList\\": [\\n \\"\\"\\n ],\\n \\"datum\\": \\"\\",\\n \\"cond\\": \\"\\",\\n \\"divisor\\": 0,\\n \\"remainder\\": 0,\\n \\"rate\\": 0,\\n \\"index\\": 0,\\n \\"expr\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RouteStatus\\": 1\\n }\\n ],\\n \\"TotalSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'ListApplicationsWithTagRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListApplicationsWithTagRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'ListAuthPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DbGrayEnable', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17061', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], + ], + 'parameters' => [ + [ + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启数据库灰度', - 'description' => 'Specifies whether to enable database canary release.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'RecordCanaryDetail', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启记录请求详情', - 'description' => 'Specifies whether to record request details.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Paths', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'RouteIds', + 'name' => 'Source', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '路由ID列表（以云原生网关为入口时，在创建泳道组的泳道前，需调用本接口传入选择的云原生网关路由ID列表）', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], + 'schema' => ['description' => 'The source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'edasmsc', 'title' => ''], ], [ - 'name' => 'CanaryModel', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The Protocol Type. Valid values:'."\n" + ."\n" + .'- **SPRING\\_CLOUD**.'."\n" + ."\n" + .'- **DUBBO**.'."\n" + ."\n" + .'- **istio**.', 'type' => 'string', 'required' => false, 'example' => 'SPRING_CLOUD', 'title' => ''], ], [ - 'name' => 'SwimVersion', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The authentication rule name.', 'type' => 'string', 'required' => false, 'example' => 'auto-rule-**', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'jgy4cadmqo@***', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The MSE namespace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the response is displayed. Valid values: zh-CN (default): Chinese, en-US: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000'."\n", - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05A5A150-4A5F-5A8C-97D6-710776CC8408', 'title' => ''], 'Data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The data overview.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'example' => 'example-app', - ], - 'DbGrayEnable' => [ - 'title' => '是否开启数据库灰度', - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'UserId' => [ - 'title' => '应用所属的用户id。', - 'description' => 'The ID of the user to which the application belongs.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'MessageQueueFilterSide' => [ - 'title' => '消息灰度过滤侧', - 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", - 'type' => 'string', - 'example' => 'Client', - ], - 'AppIds' => [ - 'title' => '应用id列表，逗号分隔。', - 'description' => 'The list of application IDs that are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => 'abcd1@abcde123,abcd1@abcde124', - ], - 'Namespace' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the MSE namespace.'."\n", - 'type' => 'string', - 'example' => 'prod', - ], - 'RecordCanaryDetail' => [ - 'title' => '是否开启记录请求详情。', - 'description' => 'Specifies whether to record request details.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'title' => '泳道组id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2047', - 'default' => '123', - ], - 'EntryApp' => [ - 'title' => '入口应用。格式 "来源系统:id"。比如：'."\n" - .'mse:${mse应用id}'."\n" - .'mse-gw:${mse云原生网关id}', - 'description' => 'The ingress application.'."\n", - 'type' => 'string', - 'example' => 'mse:abcd1@a2345', - ], - 'Region' => [ - 'title' => '应用所属地域。', - 'description' => 'The region where the application resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MessageQueueGrayEnable' => [ - 'title' => '是否开启消息灰度。', - 'description' => 'Specifies whether to enable canary release for messaging.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'paths' => [ - 'type' => 'string', - ], - 'Paths' => [ - 'type' => 'string', - ], - 'canaryModel' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CanaryModel' => [ - 'type' => 'integer', - 'format' => 'int32', + 'Result' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AuthRule' => [ + 'description' => 'The list of service authentication rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The service authentication rule.', + 'type' => 'object', + 'properties' => [ + 'Black' => ['description' => 'Indicates whether it is a blacklist.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'example' => '/a', 'title' => ''], + 'Method' => [ + 'description' => 'The request method.', + 'type' => 'object', + 'properties' => [ + 'Version' => ['description' => 'The method version number.', 'type' => 'string', 'example' => '0.0.1', 'title' => ''], + 'ParameterTypes' => [ + 'description' => 'The list of request parameter types.', + 'type' => 'array', + 'items' => ['description' => 'The request parameter type.', 'type' => 'string', 'example' => '[\\"java.lang.String\\",\\"java.lang.Object\\",\\"java.lang.String\\"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Name' => ['description' => 'The method name.', 'type' => 'string', 'example' => 'hello', 'title' => ''], + 'Group' => ['description' => 'The group.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'ReturnType' => ['description' => 'The return value type.', 'type' => 'string', 'example' => 'Boolean', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'AppIds' => [ + 'description' => 'The application collection.', + 'type' => 'array', + 'items' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '["dez4qt7weh@***"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AuthType' => ['description' => 'The rule type.'."\n" + ."\n" + .'- 0, by application dimension.'."\n" + ."\n" + .'- 1, by namespace dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'K8sNamespaces' => [ + 'description' => 'The namespace list.', + 'type' => 'array', + 'items' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'acced****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NamespaceId' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => 'ced54a95-4e33-4bda-be7e-37e95868***', 'title' => ''], + 'Protocol' => ['description' => 'The Protocol Type. Valid values:'."\n" + ."\n" + .'- **SPRING\\_CLOUD**.'."\n" + ."\n" + .'- **DUBBO**.'."\n" + ."\n" + .'- **istio**.', 'type' => 'string', 'example' => 'SPRING_CLOUD', 'title' => ''], + 'AccountId' => ['description' => 'The Alibaba Cloud account ID of the resource owner.', 'type' => 'string', 'example' => '19039813784***', 'title' => ''], + 'Source' => ['description' => 'The application source.', 'type' => 'string', 'example' => 'edasmsc', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1po62@5f1b08becb*****', 'title' => ''], + 'Name' => ['description' => 'The authentication rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '204', 'title' => ''], + 'Enable' => ['description' => 'Enable or disable.'."\n" + ."\n" + .'- `true`: Enable.'."\n" + ."\n" + .'- `false`: disable.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AuthType' => ['description' => 'The rule type.'."\n" + ."\n" + .'- 0: by application dimension.'."\n" + ."\n" + .'- 1: by namespace dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'K8sNamespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], - 'example' => '{}', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'The request result, with the following values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"05A5A150-4A5F-5A8C-97D6-710776CC8408\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Status\\": 1,\\n \\"AuthRule\\": [\\n {\\n \\"Black\\": false,\\n \\"Path\\": \\"/a\\",\\n \\"Method\\": {\\n \\"Version\\": \\"0.0.1\\",\\n \\"ParameterTypes\\": [\\n \\"[\\\\\\\\\\\\\\"java.lang.String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"java.lang.Object\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"java.lang.String\\\\\\\\\\\\\\"]\\"\\n ],\\n \\"ServiceName\\": \\"spring-cloud-a\\",\\n \\"Name\\": \\"hello\\",\\n \\"Group\\": \\"default\\",\\n \\"ReturnType\\": \\"Boolean\\"\\n },\\n \\"AppIds\\": [\\n \\"[\\\\\\"dez4qt7weh@***\\\\\\"]\\"\\n ],\\n \\"AuthType\\": 0,\\n \\"K8sNamespaces\\": [\\n \\"acced****\\"\\n ]\\n }\\n ],\\n \\"NamespaceId\\": \\"ced54a95-4e33-4bda-be7e-37e95868***\\",\\n \\"Protocol\\": \\"SPRING_CLOUD\\",\\n \\"AccountId\\": \\"19039813784***\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"Name\\": \\"test\\",\\n \\"Id\\": 204,\\n \\"Enable\\": false,\\n \\"AuthType\\": 0,\\n \\"K8sNamespace\\": \\"c19c6c500e1ff4d7abc7bed9b8236***\\"\\n }\\n ],\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListAuthPolicy', + 'summary' => 'Call the ListAuthPolicy API to query the list of service authentication rules.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\\\n\\",\\n \\"Data\\": {\\n \\"Name\\": \\"example-app\\",\\n \\"DbGrayEnable\\": \\"true\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"AppIds\\": \\"abcd1@abcde123,abcd1@abcde124\\",\\n \\"Namespace\\": \\"prod\\",\\n \\"RecordCanaryDetail\\": true,\\n \\"Id\\": 2047,\\n \\"EntryApp\\": \\"mse:abcd1@a2345\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": true,\\n \\"paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"Paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"canaryModel\\": 0,\\n \\"CanaryModel\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'CreateOrUpdateSwimmingLaneGroup', + 'translator' => 'manual', ], - 'DeleteSwimmingLaneGroup' => [ - 'summary' => 'Deletes a lane group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListCircuitBreakerRules' => [ + 'summary' => 'Queries circuit breaker rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '145', - ], + 'schema' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'], ], [ - 'name' => 'Namespace', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'spring-cloud-a'], ], [ - 'name' => 'Name', + 'name' => 'ResourceSearchKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - ], + 'schema' => ['description' => 'The interface keyword in the protection rule.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => 'The interface for which the protection rule is configured.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '/a'], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The first page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 6.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh-CN (default value): Chinese. en-US: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'any', - 'example' => '{}', + 'title' => '', + 'description' => 'The rules.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'RuleId' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'title' => '', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => 'The name of the interface to which the rule applies. The interface name must be the same as that displayed on the API Details page in the console.', 'type' => 'string', 'title' => '', 'example' => '/a'], + 'ResourceType' => ['description' => 'The interface resource type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Strategy' => [ + 'description' => 'The threshold type.', + 'enumValueTitles' => ['慢调用比例', '异常比例'], + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '0', + ], + 'Threshold' => ['description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.8'], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RetryTimeoutMs' => ['description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the resources, all requests quickly fail in the configured duration.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10000'], + 'StatIntervalMs' => ['description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20000'], + 'AppId' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'RegionId' => ['description' => 'The region in which the cluster resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'FallbackObject' => ['description' => 'The behavior that was bound to the rule.', 'type' => 'string', 'title' => '', 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"'], + 'MaxAllowedRtMs' => ['description' => 'The maximum RT. Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'MinRequestAmount' => ['description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'HalfOpenBaseAmountPerStep' => ['description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + 'HalfOpenRecoveryStepNum' => ['description' => 'The number of circuit breaking recovery steps.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['description' => 'The first page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'TotalSize' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + ], + 'example' => '', ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"ResourceType\\": 1,\\n \\"Strategy\\": 0,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"StatIntervalMs\\": 20000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 3\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListCircuitBreakerRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"{}\\"\\n}","type":"json"}]', - 'title' => 'DeleteSwimmingLaneGroup', ], - 'CreateOrUpdateSwimmingLane' => [ - 'summary' => 'Creates or updates a lane for end-to-end canary release.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusterConnectionTypes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '116127', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '76158', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Namespace', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8625467C-27DD-5711-878E-6857E3074937'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'ShowName' => ['description' => 'The connection type.'."\n", 'type' => 'string', 'example' => 'slb'], + ], + ], + ], + ], ], ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '泳道ID。-1时为创建泳道，大于0时为修改指定泳道。', - 'description' => 'The ID of the primary key. The value -1 indicates a request that is used to create a lane. A value greater than 0 indicates a request that is used to modify a lane.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => 'The name of the lane.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Test lane'."\n", - 'maxLength' => 64, - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'schema' => [ - 'title' => '匹配到后的目标机器标签', - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - 'maxLength' => 64, - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8625467C-27DD-5711-878E-6857E3074937\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"ShowName\\": \\"slb\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterConnectionTypes', + 'summary' => 'Queries available cluster connection types.', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启。', - 'description' => 'Specifies whether to enable the lane.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterConnectionTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListClusterHealthCheckTask' => [ + 'summary' => 'Retrieves information about historical health check tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '所属泳道组', - 'description' => 'The language of the response. Valid values:****'."\n" - ."\n" - .'* **zh-CN**: Chinese'."\n" - .'* **en-US**: English'."\n" - ."\n" - .'> Default value: **zh-CN**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '115', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '150980', + 'abilityTreeNodes' => ['FEATUREmseZDUZ1K'], + ], + 'parameters' => [ [ - 'name' => 'EnableRules', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启规则', - 'description' => 'Specifies whether to configure a routing rule for the lane. If an Ingress gateway is used, this parameter is not required.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-7pp2o4wfx01', 'title' => ''], ], [ - 'name' => 'PathIndependentPercentageEnable', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'EntryRules', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => 'SwimmingLane', - 'description' => 'The lane.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Paths' => [ - 'title' => '路径列表', - 'description' => 'The paths.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - 'required' => false, - 'maxItems' => 50, - ], - 'Condition' => [ - 'title' => '指示RestItems如何组合成最终的条件', - 'description' => 'Specifies how RESTful items are combined into the final condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - 'default' => 'AND', - 'enum' => [ - 'AND', - 'OR', - ], - ], - 'RestItems' => [ - 'title' => '匹配列表', - 'description' => 'The matching list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '匹配类型', - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'header', - ], - 'Name' => [ - 'title' => '名称', - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'Operator' => [ - 'title' => '操作符', - 'description' => 'The operator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mod', - ], - 'NameList' => [ - 'title' => '匹配列表', - 'description' => 'The matching list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'A081', - ], - 'required' => false, - 'maxItems' => 10, - ], - 'Datum' => [ - 'title' => '数值', - 'description' => 'The value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.params[0]', - ], - 'Cond' => [ - 'title' => '匹配符', - 'description' => 'The matching character.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '=', - ], - 'Divisor' => [ - 'title' => '除数', - 'description' => 'The divisor.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Remainder' => [ - 'title' => '余数', - 'description' => 'The remainder.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Rate' => [ - 'title' => '百分比', - 'description' => 'The percentage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Value' => [ - 'title' => '值', - 'description' => 'The value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - 'Priority' => [ - 'title' => '优先级', - 'description' => 'The priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], - ], - 'required' => false, - 'description' => 'The information about the routing rule for the ingress application.'."\n", - ], - 'required' => false, - 'maxItems' => 10, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'EntryRule', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'json string', - 'description' => 'The JSON string.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The region in which the cluster resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GatewaySwimmingLaneRouteJson', + 'name' => 'RequestPars', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '网关路由信息（使用云原生网关为入口时使用）', - 'description' => 'The information about the routing rule for the gateway. This parameter is required when a cloud-native gateway is used as the ingress.'."\n", - 'type' => 'object', - 'properties' => [ - 'GatewayId' => [ - 'title' => '网关ID', - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'title' => '网关唯一ID', - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-84efde2ee1464260bdb17a5b****', - ], - 'RouteIdList' => [ - 'title' => '路由ID列表', - 'description' => 'The route IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'CanaryModel' => [ - 'title' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Conditions' => [ - 'title' => '匹配条件列表（按内容路由使用）', - 'description' => 'The matching conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '参数名称', - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Value' => [ - 'title' => '参数值', - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xiaoming', - ], - 'Type' => [ - 'title' => '参数类型：'."\n" - .'- header：Header'."\n" - .'- param：Parameter', - 'description' => 'The type of the parameter. Valid values:'."\n" - ."\n" - .'* header'."\n" - .'* param'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'header', - ], - 'Cond' => [ - 'title' => '条件：'."\n" - .'- PRE：前缀匹配'."\n" - .'- EQUAL：精确匹配'."\n" - .'- ERGULAR：正则匹配', - 'description' => 'The matching condition. Valid values:'."\n" - ."\n" - .'* PRE: prefix matching'."\n" - .'* EQUAL: exact matching'."\n" - .'* ERGULAR: regular expression matching'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Percentage' => [ - 'title' => '流量比例（按比例路由使用，取值0-100）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'RouteIndependentPercentageEnable' => [ - 'type' => 'boolean', - ], - 'RouteIndependentPercentageList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RouteId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Percentage' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - 'Condition' => [ - 'type' => 'string', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The extended request parameter in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. The value 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'Code is only used to synchronize with success', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code. Take note of the following items:'."\n" + ."\n" + .'- Successful request: The **ErrorCode** field is not returned.'."\n" + ."\n" + .'- Failed request: The **ErrorCode** field is returned. For more information, see the **Error codes** section in this topic.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['description' => 'The dynamic part in the error message.', 'type' => 'string', 'title' => '', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic error message used to replace \\*\\*%s\\*\\* in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If **ErrMessage** returns **The Value of Input Parameter %s is not valid**, and **DynamicMessage** returns **DtsJobId**, it indicates that the **DtsJobId** request parameter is invalid.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the lane.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'id' => [ - 'description' => 'The ID of the lane.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94765', - ], - 'tag' => [ - 'description' => 'The tag of the lane.'."\n", - 'type' => 'string', - 'example' => 'release', - ], - 'status' => [ - 'description' => 'The status of the lane.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'enable' => [ - 'description' => 'Indicates whether the lane was enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'regionId' => [ - 'description' => 'The ID of the region where the application is deployed.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'groupId' => [ - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72586', - ], - 'entryRule' => [ - 'description' => 'The rule for the ingress application.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'entryRules' => [ - 'description' => 'The name.'."\n", + 'PageNumber' => ['description' => 'The page number of the list.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalSize' => ['description' => 'The total number of queried rules.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '9'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'Result' => [ + 'description' => 'The list of health check tasks.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The health check task.', 'type' => 'object', 'properties' => [ - 'paths' => [ - 'description' => 'The paths.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The paths.'."\n", - 'type' => 'string', - 'example' => '/', - ], - ], - 'path' => [ - 'title' => '', - 'description' => 'The path of the code group.'."\n", - 'type' => 'string', - 'example' => '/adump/wxb/prod', - ], - 'condition' => [ - 'description' => 'The condition.'."\n", - 'type' => 'string', - 'example' => 'AND', - ], - 'restItems' => [ - 'description' => 'The conditions to be met.'."\n", + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Score' => ['description' => 'The total score.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'TotalItem' => ['description' => 'The total number of inspection items.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalRisk' => ['description' => 'The total number of risk items.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'mse_ingresspost-cn-0jbvrcex****', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the instance.', 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], + 'Type' => ['description' => 'Redundant field.', 'type' => 'string', 'example' => 'null'."\n", 'title' => ''], + 'Status' => ['description' => 'The job states.', 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'PrimaryUser' => ['description' => 'The ID of the user to which the cluster belongs.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Spec' => ['description' => 'The specifications.', 'type' => 'string', 'example' => 'MSE_SC_2_4_200_c', 'title' => ''], + 'Replica' => ['description' => 'The number of nodes in the cluster.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'VersionCode' => ['description' => 'The version number.', 'type' => 'string', 'example' => 'NACOS_ANS_1_2_1_3', 'title' => ''], + 'AppVersion' => ['description' => 'The complete version number.', 'type' => 'string', 'example' => '1.2.1', 'title' => ''], + 'ImageVersion' => ['description' => 'Redundant field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2022-06-20T06:51:46Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2022-11-12 15:07:55', 'title' => ''], + 'RiskList' => [ + 'description' => 'The list of risk items.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The information about risk items.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '匹配类型', - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'cookie', - ], - 'name' => [ - 'title' => '名称', - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'operator' => [ - 'title' => '操作符', - 'description' => 'The operator.'."\n", - 'type' => 'string', - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'title' => '匹配列表', - 'description' => 'The names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'maxItems' => 10, - ], - 'datum' => [ - 'title' => '数值', - 'description' => 'The value.'."\n", - 'type' => 'string', - 'example' => 'x', - ], - 'cond' => [ - 'title' => '匹配符', - 'description' => 'The matching character.'."\n", - 'type' => 'string', - 'example' => '==', - ], - 'divisor' => [ - 'title' => '除数', - 'description' => 'The divisor.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'remainder' => [ - 'title' => '余数', - 'description' => 'The remainder.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'rate' => [ - 'title' => '百分比', - 'description' => 'The percentage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'value' => [ - 'title' => '值', - 'description' => 'The value.'."\n", - 'type' => 'string', - 'example' => '9', - ], + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '3426', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the associated parent task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RiskName' => ['description' => 'The risk name.', 'type' => 'string', 'example' => 'Engine version too low', 'title' => ''], + 'RiskCode' => ['description' => 'The risk code.', 'type' => 'string', 'example' => '22020010001', 'title' => ''], + 'PrimaryUser' => ['description' => 'The ID of the user to which the cluster belongs.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Type' => ['description' => 'Redundant field.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], + 'Values' => ['description' => 'Redundant field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Module' => ['description' => 'Redundant field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'RiskType' => ['description' => 'The type of the risk.', 'type' => 'string', 'example' => 'Version risk', 'title' => ''], + 'RiskLevel' => ['title' => 'HIGH, MID, LOW, NONE', 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'- HIGH: High risk'."\n" + ."\n" + .'- MID: Medium risk'."\n" + ."\n" + .'- LOW: Low risk', 'type' => 'string', 'example' => 'MID'], + 'Suggestion' => ['description' => 'The suggestion.', 'type' => 'string', 'example' => '{"desc": "Upgrade to the latest version at the earliest opportunity.", "links":[{"type":"upgrade","desc":"Click to upgrade"}]}', 'title' => ''], + 'Situation' => ['description' => 'The current situation.', 'type' => 'string', 'example' => '{"desc":"The current engine version is too low with many missing features","links":[{"type":"url","value":"https://xxxx"","desc":"Version notes"}]}', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '{"desc":"The engine version is outdated and many features are missing. Upgrade to the latest version at the earliest opportunity."}', 'title' => ''], + 'Mute' => ['description' => 'Specifies whether to disable the notification feature if the risk item occurs.'."\n" + ."\n" + .'- true: Disables risk item notifications'."\n" + ."\n" + .'- false: Enables risk item notifications', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'NoticeFeature' => ['description' => 'Redundant field.', 'type' => 'boolean', 'example' => 'null', 'title' => ''], + 'RiskNameEn' => ['description' => 'The English name of the risk.', 'type' => 'string', 'example' => 'Low engine version', 'title' => ''], + 'SuggestionEn' => ['description' => 'The English description of the suggestion.', 'type' => 'string', 'example' => 'Upgrade to the latest version', 'title' => ''], + 'SituationEn' => ['description' => 'The English description of the current situation.', 'type' => 'string', 'example' => 'The current engine version is low, and there are many missing features', 'title' => ''], + 'DescriptionEn' => ['description' => 'The English description of the risk.', 'type' => 'string', 'example' => 'Upgrade to the latest version to ensure that all features are available!', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ChargeType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'enableRules' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'gmtCreate' => [ - 'description' => 'The time when the lane was created.'."\n", - 'type' => 'string', - 'example' => '1545726028000', - ], - 'gmtModified' => [ - 'description' => 'The time when the lane was updated.'."\n", - 'type' => 'string', - 'example' => '1565701886000', - ], - 'gatewaySwimmingLaneRouteJson' => [ - 'description' => 'The routing rule for the MSE gateway.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'pathIndependentPercentageEnable' => [ - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 9,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Score\\": 60,\\n \\"TotalItem\\": 10,\\n \\"TotalRisk\\": 3,\\n \\"InstanceId\\": \\"mse_ingresspost-cn-0jbvrcex****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"Type\\": \\"null\\\\n\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"PrimaryUser\\": \\"123456\\",\\n \\"Spec\\": \\"MSE_SC_2_4_200_c\\",\\n \\"Replica\\": \\"3\\",\\n \\"VersionCode\\": \\"NACOS_ANS_1_2_1_3\\",\\n \\"AppVersion\\": \\"1.2.1\\",\\n \\"ImageVersion\\": \\"null\\",\\n \\"CreateTime\\": \\"2022-06-20T06:51:46Z\\",\\n \\"UpdateTime\\": \\"2022-11-12 15:07:55\\",\\n \\"RiskList\\": [\\n {\\n \\"Id\\": 3426,\\n \\"TaskId\\": 1,\\n \\"RiskName\\": \\"Engine version too low\\",\\n \\"RiskCode\\": \\"22020010001\\",\\n \\"PrimaryUser\\": \\"123456\\",\\n \\"Type\\": 0,\\n \\"Values\\": \\"null\\",\\n \\"Module\\": \\"null\\",\\n \\"RiskType\\": \\"Version risk\\",\\n \\"RiskLevel\\": \\"MID\\",\\n \\"Suggestion\\": \\"{\\\\\\"desc\\\\\\": \\\\\\"Upgrade to the latest version at the earliest opportunity.\\\\\\", \\\\\\"links\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"upgrade\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Click to upgrade\\\\\\"}]}\\",\\n \\"Situation\\": \\"{\\\\\\"desc\\\\\\":\\\\\\"The current engine version is too low with many missing features\\\\\\",\\\\\\"links\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"url\\\\\\",\\\\\\"value\\\\\\":\\\\\\"https://xxxx\\\\\\"\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Version notes\\\\\\"}]}\\",\\n \\"Description\\": \\"{\\\\\\"desc\\\\\\":\\\\\\"The engine version is outdated and many features are missing. Upgrade to the latest version at the earliest opportunity.\\\\\\"}\\",\\n \\"Mute\\": false,\\n \\"NoticeFeature\\": true,\\n \\"RiskNameEn\\": \\"Low engine version\\",\\n \\"SuggestionEn\\": \\"Upgrade to the latest version\\",\\n \\"SituationEn\\": \\"The current engine version is low, and there are many missing features\\",\\n \\"DescriptionEn\\": \\"Upgrade to the latest version to ensure that all features are available!\\"\\n }\\n ],\\n \\"ChargeType\\": \\"PREPAY\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListClusterHealthCheckTask', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterHealthCheckTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": {\\n \\"name\\": \\"test\\",\\n \\"id\\": 94765,\\n \\"tag\\": \\"release\\",\\n \\"status\\": 0,\\n \\"enable\\": true,\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"groupId\\": 72586,\\n \\"entryRule\\": \\"{}\\",\\n \\"entryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/adump/wxb/prod\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"test\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"9\\"\\n }\\n ]\\n }\\n ],\\n \\"enableRules\\": true,\\n \\"gmtCreate\\": \\"1545726028000\\",\\n \\"gmtModified\\": \\"1565701886000\\",\\n \\"gatewaySwimmingLaneRouteJson\\": \\"{}\\",\\n \\"pathIndependentPercentageEnable\\": false\\n }\\n}","type":"json"}]', - 'title' => 'CreateOrUpdateSwimmingLane', ], - 'DeleteSwimmingLane' => [ - 'summary' => 'Deletes a lane.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusterTypes' => [ + 'summary' => 'Queries the engine types that can be activated.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'LaneId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the lane.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '229', - ], + 'schema' => ['description' => 'The region where the cluster is located, regions supported by MSE.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ConnectType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'- slb'."\n" + ."\n" + .'- eni', 'type' => 'string', + 'example' => 'slb', + 'enum' => ['eni', 'slb'], + 'title' => '', 'required' => false, - 'example' => 'default', - 'maxLength' => 64, ], ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => ['description' => 'The MSE cluster version to be activated.'."\n" + ."\n" + .'- mse\\_pro: Professional Edition.'."\n" + ."\n" + .'- mse\\_dev: Developer Edition.', 'type' => 'string', 'required' => false, 'example' => 'mse_pro', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '821B5B05-8919-5FBB-BA75-417BFC093EB8', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The return value.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic error message, used to replace \\*\\*%s\\*\\* in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If **ErrMessage** returns **The Value of Input Parameter %s is not valid**, and **DynamicMessage** returns **DtsJobId**, it indicates that the request parameter **DtsJobId** is invalid.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the engine type.', 'type' => 'string', 'example' => 'ZooKeeper', 'title' => ''], + 'ShowName' => ['description' => 'The MSE engine type that can be activated.', 'type' => 'string', 'example' => 'Zookeeper', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"821B5B05-8919-5FBB-BA75-417BFC093EB8\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"ZooKeeper\\",\\n \\"ShowName\\": \\"Zookeeper\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterTypes', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\"\\n}","type":"json"}]', - 'title' => 'DeleteSwimmingLane', + 'translator' => 'manual', ], - 'QueryAllSwimmingLaneGroup' => [ - 'summary' => 'Queries all lane groups.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusterVersions' => [ + 'summary' => 'Queries the information about supported instance versions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -28283,240 +18999,106 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '116120', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Nacos-Ans', 'title' => ''], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'* `mse_dev`: Developer Edition.'."\n" + .'* `mse_pro`: Professional Edition. This is the default value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_pro', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'DynamicMessage' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7717BE5B-C958-5F87-BF49-464AA276EDD1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '泳道组名称', - 'description' => 'The name of the lane group.'."\n", - 'type' => 'string', - 'example' => 'swimmingGroup', - ], - 'UserId' => [ - 'title' => '泳道所属的用户id', - 'description' => 'The ID of the user to which the lane belongs.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'MessageQueueFilterSide' => [ - 'title' => '在哪一侧实现消息灰度', - 'description' => 'The side at which canary release for messaging was enabled.'."\n", - 'type' => 'string', - 'example' => 'Client', - ], - 'AppIds' => [ - 'title' => '应用Id列表', - 'description' => 'The application IDs.'."\n", - 'type' => 'string', - 'example' => 'abcde@abcde,abcde@abcde', - ], - 'Namespace' => [ - 'title' => '泳道所属的MSE命名空间', - 'description' => 'The MSE namespace to which the lane belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'RecordCanaryDetail' => [ - 'title' => '是否记录请求详情（全链路灰度可观测）', - 'description' => 'Indicates whether the request details (metrics of end-to-end canary release) were recorded.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Id' => [ - 'title' => '泳道组Id', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'EntryApp' => [ - 'title' => '入口应用类型+入口应用Id', - 'description' => 'The type and ID of the ingress application.'."\n", - 'type' => 'string', - 'example' => 'mse:abcde@abcde', - ], - 'Region' => [ - 'title' => '所属地域', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MessageQueueGrayEnable' => [ - 'title' => '是否开启消息灰度', - 'description' => 'Indicates whether canary release for messaging is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Paths' => [ - 'type' => 'string', - ], - 'paths' => [ - 'type' => 'string', - ], - 'CanaryModel' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'canaryModel' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SwimVersion' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'swimVersion' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Code' => ['description' => 'The code of the instance type.'."\n", 'type' => 'string', 'example' => 'NACOS_2_0_0', 'title' => ''], + 'ShowName' => ['description' => 'The version of the instance.'."\n", 'type' => 'string', 'example' => '2.1.0', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the instance.'."\n", 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'example' => '[{id:100,name:"test"}]'."\n", + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7717BE5B-C958-5F87-BF49-464AA276EDD1\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"NACOS_2_0_0\\",\\n \\"ShowName\\": \\"2.1.0\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterVersions', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"swimmingGroup\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"AppIds\\": \\"abcde@abcde,abcde@abcde\\",\\n \\"Namespace\\": \\"default\\",\\n \\"RecordCanaryDetail\\": false,\\n \\"Id\\": 123,\\n \\"EntryApp\\": \\"mse:abcde@abcde\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": true,\\n \\"Paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"CanaryModel\\": 0,\\n \\"canaryModel\\": 0,\\n \\"SwimVersion\\": 2,\\n \\"swimVersion\\": 2\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'QueryAllSwimmingLaneGroup', ], - 'QueryAllSwimmingLane' => [ - 'summary' => 'Queries all the lanes in a lane group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusters' => [ + 'summary' => 'Lists the registration and configuration center clusters.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -28526,498 +19108,188 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '116125', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], + 'abilityTreeCode' => '17063', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of clusters per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterAliasName', + 'in' => 'query', + 'schema' => ['description' => 'The cluster alias. This parameter supports fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'cluster', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the MSE region where the cluster is deployed.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group. For more information, see View resource group basic information.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxbzafebvvfa', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the MSE namespace.'."\n", - 'type' => 'string', + 'description' => 'A list of tags. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'prd', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'KeyId', 'in' => 'query', - 'schema' => [ - 'title' => '泳道组id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '186', - ], + 'schema' => ['description' => 'For Nacos clusters, returns clusters with instances bound to the specified key ID.', 'type' => 'string', 'required' => false, 'example' => 'key-hzz67774641bsp21vhj4h', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The response language. Valid values:'."\n" + ."\n" + .'- `zh`: Chinese'."\n" + ."\n" + .'- `en`: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageSize' => ['description' => 'The number of instances per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The list of clusters.', 'type' => 'array', 'items' => [ + 'description' => 'The cluster details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '泳道组名称。', - 'description' => 'The name of the lane group.'."\n", - 'type' => 'string', - 'example' => 'swimmingGroup', - ], - 'UserId' => [ - 'title' => '泳道所属的用户id。', - 'description' => 'The user ID of the lane group.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'MessageQueueFilterSide' => [ - 'title' => '在哪一侧实现消息灰度。', - 'description' => 'The side on which canary release for messaging is implemented.'."\n", - 'type' => 'string', - 'example' => 'Client', - ], - 'Enable' => [ - 'title' => '是否开启。', - 'description' => '是否开启。', - 'type' => 'string', - 'example' => 'true', - ], - 'Namespace' => [ - 'title' => '泳道所属的MSE命名空间。', - 'description' => 'The Microservices Engine (MSE) namespace to which the lane belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'RecordCanaryDetail' => [ - 'title' => '是否记录请求详情（全链路灰度可观测）。', - 'description' => 'Indicates whether request details were recorded (metrics of end-to-end canary release).'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Id' => [ - 'title' => '泳道组Id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RegionId' => [ - 'title' => '所属地域。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MessageQueueGrayEnable' => [ - 'title' => '是否开启消息灰度。', - 'description' => 'Indicates whether canary release for messaging is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'enableRules' => [ - 'title' => '是否开启规则。', - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EntryRules' => [ - 'description' => 'The ingress application rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'paths' => [ - 'description' => 'The paths.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/', - ], - ], - 'path' => [ - 'title' => '', - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/adump/wxb/prod', - ], - 'condition' => [ - 'description' => 'The condition.'."\n", - 'type' => 'string', - 'example' => 'AND', - ], - 'restItems' => [ - 'description' => 'The RESTful matching rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '匹配类型', - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'cookie', - ], - 'name' => [ - 'title' => '名称', - 'description' => 'The name of the matching rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'operator' => [ - 'title' => '操作符', - 'description' => 'The operator.'."\n", - 'type' => 'string', - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'title' => '匹配列表', - 'description' => 'The matching list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the matching rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'maxItems' => 10, - ], - 'datum' => [ - 'title' => '数值', - 'description' => 'The value.'."\n", - 'type' => 'string', - 'example' => 'x', - ], - 'cond' => [ - 'title' => '匹配符', - 'description' => 'The matching character.'."\n", - 'type' => 'string', - 'example' => '==', - ], - 'divisor' => [ - 'title' => '除数', - 'description' => 'The divisor.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'remainder' => [ - 'title' => '余数', - 'description' => 'The remainder.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'rate' => [ - 'title' => '百分比', - 'description' => 'The percentage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'value' => [ - 'title' => '值', - 'description' => 'The value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - ], - 'gmtCreate' => [ - 'title' => '泳道创建时间。', - 'description' => 'The time when the lane was created.'."\n", - 'type' => 'string', - 'example' => '1683598484000', - ], - 'gmtModified' => [ - 'title' => '泳道更新时间。', - 'description' => 'The time when the lane was updated.'."\n", - 'type' => 'string', - 'example' => '1683598484000', - ], - 'groupId' => [ - 'title' => '泳道组Id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'string', - 'example' => '72709', - ], - 'GroupId' => [ - 'title' => '泳道组Id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'string', - 'example' => '6859', - ], - 'tag' => [ - 'title' => '泳道对应的标签。', - 'description' => 'The tag of the lane.'."\n", - 'type' => 'string', - 'example' => 'gray', - ], - 'Tag' => [ - 'title' => '泳道对应的标签。', - 'description' => 'The tag of the lane.'."\n", - 'type' => 'string', - 'example' => 'gray', - ], - 'GatewaySwimmingLaneRoute' => [ - 'title' => '网关路由信息（使用云原生网关为入口时使用）', - 'description' => '网关路由信息（使用云原生网关为入口时使用）', + 'EndDate' => ['description' => 'The time when the subscription for the cluster expires.', 'type' => 'string', 'example' => '2021-08-01 00:00:00', 'title' => ''], + 'IntranetDomain' => ['description' => 'The intranet domain name of the cluster.', 'type' => 'string', 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', 'title' => ''], + 'InternetDomain' => ['description' => 'The internet domain name of the cluster.', 'type' => 'string', 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2020-07-31 11:36:08', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method. Valid values: `subscription` and `pay-as-you-go`.', 'type' => 'string', 'example' => 'subscription', 'title' => ''], + 'IntranetAddress' => ['description' => 'The intranet IP address of the cluster.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'InternetAddress' => ['description' => 'The internet IP address of the cluster.', 'type' => 'string', 'example' => '47.98.XX.XX', 'title' => ''], + 'ClusterAliasName' => ['description' => 'The cluster alias.', 'type' => 'string', 'example' => 'mse-7413****', 'title' => ''], + 'ClusterType' => ['description' => 'The cluster type. Valid values: `ZooKeeper`, `Nacos-Ans`, and `Eureka`.', 'type' => 'string', 'example' => 'Eureka', 'title' => ''], + 'InitStatus' => ['description' => 'The initialization status.', 'type' => 'string', 'example' => 'RESTART_SUCCESS', 'title' => ''], + 'AppVersion' => ['description' => 'The app version.', 'type' => 'string', 'example' => '1.9.3', 'title' => ''], + 'CanUpdate' => ['description' => 'Indicates whether the cluster can be upgraded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'VersionCode' => ['description' => 'The code of the cluster version.', 'type' => 'string', 'example' => 'EUREKA_1_9_3', 'title' => ''], + 'InstanceCount' => ['description' => 'The number of instances in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'MseVersion' => ['description' => 'The edition of the cluster.', 'type' => 'string', 'example' => 'mse_pro', 'title' => ''], + 'Tags' => ['description' => 'The tags attached to the cluster.', 'type' => 'object', 'title' => '', 'example' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group that contains the cluster.', 'type' => 'string', 'example' => 'rg-acfmv7jiavm4uxa', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC in which the cluster is deployed.', 'type' => 'string', 'example' => 'vpc-bp1hcg467ekqsv0zr****', 'title' => ''], + 'MaintenancePeriod' => [ 'type' => 'object', 'properties' => [ - 'GatewayId' => [ - 'title' => '网关ID', - 'description' => '网关ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'title' => '网关唯一ID', - 'description' => '网关唯一ID', - 'type' => 'string', - 'example' => 'gw-84efde2ee1464260bdb17a5b****', - ], - 'RouteIdList' => [ - 'title' => '路由ID列表', - 'description' => '路由ID列表', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'CanaryModel' => [ - 'title' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'description' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Conditions' => [ - 'title' => '匹配条件列表（按内容路由使用）', - 'description' => '匹配条件列表（按内容路由使用）', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '参数名称', - 'description' => '参数名称', - 'type' => 'string', - 'example' => 'name', - ], - 'Value' => [ - 'title' => '参数值', - 'description' => '参数值', - 'type' => 'string', - 'example' => 'xiaoming', - ], - 'Type' => [ - 'title' => '参数类型：'."\n" - .'- header：Header'."\n" - .'- param：Parameter', - 'description' => '参数类型：'."\n" - .'- header：Header'."\n" - .'- param：Parameter', - 'type' => 'string', - 'example' => 'header', - ], - 'Cond' => [ - 'title' => '条件：'."\n" - .'- PRE：前缀匹配'."\n" - .'- EQUAL：精确匹配'."\n" - .'- ERGULAR：正则匹配', - 'description' => '条件：'."\n" - .'- PRE：前缀匹配'."\n" - .'- EQUAL：精确匹配'."\n" - .'- ERGULAR：正则匹配', - 'type' => 'string', - 'example' => 'PRE', - ], - 'NameList' => [ - 'description' => 'NameList', - 'type' => 'array', - 'items' => [ - 'description' => 'Name', - 'type' => 'string', - 'example' => 'name', - ], - ], - ], - ], - ], - 'Percentage' => [ - 'title' => '流量比例（按比例路由使用，取值0-100）', - 'description' => '流量比例（按比例路由使用，取值0-100）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'RouteIndependentPercentageEnable' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'RouteIndependentPercentageList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RouteId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'Percentage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '60', - ], - ], - ], - ], - 'Condition' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AND、OR', - ], + 'StartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '02:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '06:00', 'title' => ''], ], + 'description' => 'The maintenance window.', + 'title' => '', + 'example' => '', ], - 'PathIndependentPercentageEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewaySwimmingLaneRouteJson' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"GatewayUniqueId\\":\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\",\\"Percentage\\":0,\\"RouteIdList\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\"CanaryModel\\":1,\\"Conditions\\":[]}', - ], + 'VersionLifecycle' => ['description' => 'The version lifecycle.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'example' => '[{id:100,name:"test"}]', + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"IntranetDomain\\": \\"mse-7413****-eureka.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-7413****-p.eureka.mse.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-07-31 11:36:08\\",\\n \\"ChargeType\\": \\"subscription\\",\\n \\"IntranetAddress\\": \\"192.168.XX.XX\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"InternetAddress\\": \\"47.98.XX.XX\\",\\n \\"ClusterAliasName\\": \\"mse-7413****\\",\\n \\"ClusterType\\": \\"Eureka\\",\\n \\"InitStatus\\": \\"RESTART_SUCCESS\\",\\n \\"AppVersion\\": \\"1.9.3\\",\\n \\"CanUpdate\\": true,\\n \\"VersionCode\\": \\"EUREKA_1_9_3\\",\\n \\"InstanceCount\\": 2,\\n \\"ClusterName\\": \\"mse-cn-st21ri2****\\",\\n \\"MseVersion\\": \\"mse_pro\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmv7jiavm4uxa\\",\\n \\"VpcId\\": \\"vpc-bp1hcg467ekqsv0zr****\\",\\n \\"MaintenancePeriod\\": {\\n \\"StartTime\\": \\"02:00\\",\\n \\"EndTime\\": \\"06:00\\"\\n },\\n \\"VersionLifecycle\\": \\"\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListClusters', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"swimmingGroup\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"Enable\\": \\"true\\",\\n \\"Namespace\\": \\"default\\",\\n \\"RecordCanaryDetail\\": false,\\n \\"Id\\": 123,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": false,\\n \\"enableRules\\": true,\\n \\"EntryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/adump/wxb/prod\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"test\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"test\\"\\n }\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"1683598484000\\",\\n \\"gmtModified\\": \\"1683598484000\\",\\n \\"groupId\\": \\"72709\\",\\n \\"GroupId\\": \\"6859\\",\\n \\"tag\\": \\"gray\\",\\n \\"Tag\\": \\"gray\\",\\n \\"GatewaySwimmingLaneRoute\\": {\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-84efde2ee1464260bdb17a5b****\\",\\n \\"RouteIdList\\": [\\n 1\\n ],\\n \\"CanaryModel\\": 0,\\n \\"Conditions\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Value\\": \\"xiaoming\\",\\n \\"Type\\": \\"header\\",\\n \\"Cond\\": \\"PRE\\",\\n \\"NameList\\": [\\n \\"name\\"\\n ]\\n }\\n ],\\n \\"Percentage\\": 20,\\n \\"RouteIndependentPercentageEnable\\": \\"true\\",\\n \\"RouteIndependentPercentageList\\": [\\n {\\n \\"RouteId\\": \\"12345\\",\\n \\"Percentage\\": \\"60\\"\\n }\\n ],\\n \\"Condition\\": \\"AND、OR\\"\\n },\\n \\"PathIndependentPercentageEnable\\": true,\\n \\"GatewaySwimmingLaneRouteJson\\": \\"{\\\\\\\\\\\\\\"GatewayUniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"RouteIdList\\\\\\\\\\\\\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\\\\\\\\\\\\\"CanaryModel\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Conditions\\\\\\\\\\\\\\":[]}\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'QueryAllSwimmingLane', ], - 'GetTagsBySwimmingLaneGroupId' => [ - 'summary' => 'Obtains all tags in the current lane group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListConfigTrack' => [ + 'summary' => 'Obtains the track data of a Nacos configuration center.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -29026,809 +19298,570 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '139046', + 'abilityTreeNodes' => ['FEATUREmseU19WQV'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '154', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-i7m2ne****', 'title' => ''], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the configuration.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ballot', 'title' => ''], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f3a510e2-df52-4fad-9815-42d8bc40****', 'title' => ''], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1671010148', 'title' => ''], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657178373', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable reverse ordering. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['description' => 'The IP address of the listener.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.22.2', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'Data' => [ - 'description' => 'The data of the tag.'."\n", + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Traces' => [ + 'description' => 'The track data.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The data of the tag.'."\n", - 'type' => 'string', - 'example' => '[{"desc":"k8s-pod-label","priority":100,"tag":"gray","type":"tag"}]', + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogDate' => ['description' => 'The logging time.'."\n", 'type' => 'string', 'example' => '2022-11-28 15:09:15', 'title' => ''], + 'Ts' => ['description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" + ."\n" + .'Unit: seconds.'."\n", 'type' => 'string', 'example' => '1659666529', 'title' => ''], + 'RequestIp' => ['description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'example' => '192.168.1.2', 'title' => ''], + 'ResponseIp' => ['description' => 'The response node.'."\n", 'type' => 'string', 'example' => 'mse-1973b9a0-1670834*****-reg-center-0-2', 'title' => ''], + 'DataId' => ['description' => 'The ID of the configuration.'."\n", 'type' => 'string', 'example' => 'eir-server.properties', 'title' => ''], + 'Group' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'example' => 'DEFAULT_GROUP', 'title' => ''], + 'Event' => ['description' => 'The event. Valid values:'."\n" + ."\n" + .'* pull: configuration acquisition events'."\n" + .'* persist: persistence events'."\n", 'type' => 'string', 'example' => 'pull', 'title' => ''], + 'Result' => ['description' => 'The result.'."\n", 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Delay' => ['description' => 'The response latency. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Md5' => ['description' => 'The MD5 value.'."\n", 'type' => 'string', 'example' => 'd21c9091c60daa0ff7ee2f420141e5a0', 'title' => ''], + 'Type' => ['description' => 'The release type. Valid values:'."\n" + ."\n" + .'* beta: beta release'."\n" + .'* tag: canary release'."\n" + .'* batch: batch release'."\n", 'type' => 'string', 'example' => 'beta', 'title' => ''], + 'Push' => ['description' => 'Indicates whether messages are pushed by a server. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Client' => ['description' => 'Indicates whether the request is sent from the client. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => '["gray"]', + 'title' => '', + 'example' => '', ], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0CE3ABD2-1E04-561F-A9B4-0423D50****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"LogDate\\": \\"2022-11-28 15:09:15\\",\\n \\"Ts\\": \\"1659666529\\",\\n \\"RequestIp\\": \\"192.168.1.2\\",\\n \\"ResponseIp\\": \\"mse-1973b9a0-1670834*****-reg-center-0-2\\",\\n \\"DataId\\": \\"eir-server.properties\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"Event\\": \\"pull\\",\\n \\"Result\\": \\"ok\\",\\n \\"Delay\\": \\"0\\",\\n \\"Md5\\": \\"d21c9091c60daa0ff7ee2f420141e5a0\\",\\n \\"Type\\": \\"beta\\",\\n \\"Push\\": false,\\n \\"Client\\": false\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"0CE3ABD2-1E04-561F-A9B4-0423D50****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListConfigTrack', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListConfigTrack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": [\\n \\"[{\\\\\\"desc\\\\\\":\\\\\\"k8s-pod-label\\\\\\",\\\\\\"priority\\\\\\":100,\\\\\\"tag\\\\\\":\\\\\\"gray\\\\\\",\\\\\\"type\\\\\\":\\\\\\"tag\\\\\\"}]\\"\\n ]\\n}","type":"json"}]', - 'title' => 'GetTagsBySwimmingLaneGroupId', ], - 'QuerySwimmingLaneById' => [ - 'summary' => 'Queries the information about a lane based on the lane ID.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListEngineNamespaces' => [ + 'summary' => 'Queries the namespaces of a Nacos instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '116123', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '17066', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'LaneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the lane.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '250', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-st21ri2****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], + 'HttpCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '062D13C5-DEA3-4921-8918-C49A0F1B****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '泳道名称', - 'type' => 'string', - 'example' => 'test', - ], - 'id' => [ - 'description' => '泳道ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'tag' => [ - 'description' => '泳道对应的标签。', - 'type' => 'string', - 'example' => 'gray', - ], - 'status' => [ - 'description' => '泳道状态', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'enable' => [ - 'description' => '泳道开关', - 'type' => 'boolean', - 'example' => 'true', - ], - 'regionId' => [ - 'description' => '区域ID。', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'groupId' => [ - 'description' => '泳道组Id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'entryRule' => [ - 'description' => '入口应用规则', - 'type' => 'string', - 'example' => '{}', - ], - 'entryRules' => [ - 'description' => '入口应用规则详情', - 'type' => 'array', - 'items' => [ - 'description' => '入口应用规则', - 'type' => 'object', - 'properties' => [ - 'paths' => [ - 'description' => '路径列表', - 'type' => 'array', - 'items' => [ - 'description' => '路径', - 'type' => 'string', - 'example' => '/', - ], - ], - 'path' => [ - 'title' => '', - 'description' => '路径', - 'type' => 'string', - 'example' => '/', - ], - 'condition' => [ - 'description' => '条件', - 'type' => 'string', - 'example' => 'AND', - ], - 'restItems' => [ - 'description' => 'Rest匹配规则列表', - 'type' => 'array', - 'items' => [ - 'description' => 'Rest匹配规则', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '匹配类型', - 'description' => '匹配类型', - 'type' => 'string', - 'example' => 'cookie', - ], - 'name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'example' => '11111', - ], - 'operator' => [ - 'title' => '操作符', - 'description' => '操作符', - 'type' => 'string', - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'title' => '匹配列表', - 'description' => '名称列表', - 'type' => 'array', - 'items' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => 'test', - ], - 'maxItems' => 10, - ], - 'datum' => [ - 'title' => '数值', - 'description' => '数值', - 'type' => 'string', - 'example' => 'x', - ], - 'cond' => [ - 'title' => '匹配符', - 'description' => '匹配符', - 'type' => 'string', - 'example' => '==', - ], - 'divisor' => [ - 'title' => '除数', - 'description' => '除数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'remainder' => [ - 'title' => '余数', - 'description' => '余数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'rate' => [ - 'title' => '百分比', - 'description' => '百分比', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'value' => [ - 'title' => '值', - 'description' => '值', - 'type' => 'string', - 'example' => 'hello', - ], - ], - ], - ], - ], - ], - ], - 'enableRules' => [ - 'description' => '是否开启规则。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'gmtCreate' => [ - 'description' => '规则创建时间', - 'type' => 'string', - 'example' => '1683598484000', - ], - 'gmtModified' => [ - 'description' => '规则修改时间', - 'type' => 'string', - 'example' => '1683598484000', - ], - 'gatewaySwimmingLaneRouteJson' => [ - 'description' => 'MSE网关路由规则', - 'type' => 'string', - 'example' => '{}', - ], - 'PathIndependentPercentageEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* `0`: global configuration'."\n" + .'* `1`: default namespace'."\n" + .'* `2`: custom namespace'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'NamespaceShowName' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'example' => 'public', 'title' => ''], + 'Quota' => ['description' => 'The quota.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'NamespaceDesc' => ['description' => 'The description of the namespace.'."\n", 'type' => 'string', 'example' => 'mytest', 'title' => ''], + 'ConfigCount' => ['description' => 'The quota value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ServiceCount' => ['description' => 'The number of active services.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], + 'SourceType' => ['description' => 'The source from which the namespace was created.'."\n", 'type' => 'string', 'example' => 'mse', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'example' => '{id:102,name:"test"}', + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'OperationNotSupport', 'errorMessage' => 'The current cluster does not support this operation, %s.', 'description' => 'The current cluster does not support this operation, %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"062D13C5-DEA3-4921-8918-C49A0F1B****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Type\\": 0,\\n \\"NamespaceShowName\\": \\"public\\",\\n \\"Quota\\": 200,\\n \\"Namespace\\": \\"DEFAULT\\",\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"ConfigCount\\": 1,\\n \\"ServiceCount\\": \\"3\\",\\n \\"SourceType\\": \\"mse\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListEngineNamespaces', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListEngineNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": {\\n \\"name\\": \\"test\\",\\n \\"id\\": 1,\\n \\"tag\\": \\"gray\\",\\n \\"status\\": 1,\\n \\"enable\\": true,\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"groupId\\": 8,\\n \\"entryRule\\": \\"{}\\",\\n \\"entryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"11111\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"hello\\"\\n }\\n ]\\n }\\n ],\\n \\"enableRules\\": true,\\n \\"gmtCreate\\": \\"1683598484000\\",\\n \\"gmtModified\\": \\"1683598484000\\",\\n \\"gatewaySwimmingLaneRouteJson\\": \\"{}\\",\\n \\"PathIndependentPercentageEnable\\": false\\n }\\n}","type":"json"}]', - 'title' => 'QuerySwimmingLaneById', ], - 'ListAppBySwimmingLaneGroupTags' => [ - 'summary' => 'Lists applications by tag in a specified lane group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListEurekaInstances' => [ + 'summary' => 'Queries Eureka instances.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'abilityTreeCode' => '17067', + 'abilityTreeNodes' => ['FEATUREmseKQ13CA'], ], 'parameters' => [ [ - 'name' => 'Tags', + 'name' => 'RequestPars', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '要查询的标签。', - 'description' => 'The tag based on which you want to list applications.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '要查询的标签。', - 'description' => 'The tag based on which you want to list applications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '泳道组id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字。', - 'description' => 'The name of the MSE namespace that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****', 'title' => ''], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6832e76b-bb5f-4dea-****-************', - ], - 'Success' => [ - 'title' => '请求是否成功。', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'title' => '请求错误码。', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'title' => '请求附加信息。', - 'description' => 'The additional request information.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ - 'title' => '请求返回数据。', - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '每个tag对应的应用信息列表。', - 'description' => 'The returned information.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '应用列表。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '应用所属的用户id。', - 'type' => 'string', - 'example' => '12345', - 'description' => 'The ID of the user to which the application belongs.'."\n", - ], - 'RegionId' => [ - 'title' => '应用所在地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'description' => 'The region where the application resides.'."\n", - ], - 'Namespace' => [ - 'title' => '应用所在的微服务命名空间。', - 'type' => 'string', - 'example' => 'default', - 'description' => 'The microservice namespace where the application resides.'."\n", - ], - 'AppName' => [ - 'title' => '应用名字。', - 'type' => 'string', - 'example' => 'example-app-name', - 'description' => 'The application name.'."\n", - ], - 'AppId' => [ - 'title' => '应用id。', - 'type' => 'string', - 'example' => '123456abcde@12345abcde', - 'description' => 'The application ID.'."\n", - ], - ], + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.'."\n", 'type' => 'string', 'example' => '1/1', 'title' => ''], + 'LastDirtyTimestamp' => ['description' => 'The time when the instance was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20201009115543', 'title' => ''], + 'IpAddr' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '30.5.XX.XX', 'title' => ''], + 'HomePageUrl' => ['description' => 'The URL of the homepage.'."\n", 'type' => 'string', 'example' => 'http://30.5.XX.XX:8091/', 'title' => ''], + 'HostName' => ['description' => 'The hostname.'."\n", 'type' => 'string', 'example' => '30.5.XX.XX', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'L-PC1A6A28-****.hz.ali.com:contactinfo:8091', 'title' => ''], + 'Port' => ['description' => 'The service port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8091', 'title' => ''], + 'SecurePort' => ['description' => 'The security port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '443', 'title' => ''], + 'App' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'CONTACTINFO', 'title' => ''], + 'DurationInSecs' => ['description' => 'The timeout period of the instance.\\'."\n" + .'After the specified timeout period expires, the service is unavailable by default and is deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''], + 'LastUpdatedTimestamp' => ['description' => 'The time when the instance heartbeat was last checked.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20201010071203', 'title' => ''], + 'RenewalIntervalInSecs' => ['description' => 'The maximum interval between two heartbeat checks after a heartbeat check times out.\\'."\n" + .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'VipAddress' => ['description' => 'The virtual IP address (VIP).'."\n", 'type' => 'string', 'example' => 'contactinfo', 'title' => ''], + 'Metadata' => ['description' => 'The metadata.'."\n", 'type' => 'object', 'example' => '[string]', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"1/1\\",\\n \\"LastDirtyTimestamp\\": 20201009115543,\\n \\"IpAddr\\": \\"30.5.XX.XX\\",\\n \\"HomePageUrl\\": \\"http://30.5.XX.XX:8091/\\",\\n \\"HostName\\": \\"30.5.XX.XX\\",\\n \\"InstanceId\\": \\"L-PC1A6A28-****.hz.ali.com:contactinfo:8091\\",\\n \\"Port\\": 8091,\\n \\"SecurePort\\": 443,\\n \\"App\\": \\"CONTACTINFO\\",\\n \\"DurationInSecs\\": 90,\\n \\"LastUpdatedTimestamp\\": 20201010071203,\\n \\"RenewalIntervalInSecs\\": 10,\\n \\"VipAddress\\": \\"contactinfo\\",\\n \\"Metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListEurekaInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6832e76b-bb5f-4dea-****-************\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"key\\": [\\n {\\n \\"UserId\\": \\"12345\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"example-app-name\\",\\n \\"AppId\\": \\"123456abcde@12345abcde\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListAppBySwimmingLaneGroupTags', ], - 'ListAppBySwimmingLaneGroupTag' => [ - 'summary' => 'Queries the applications in a lane group by tag.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListEurekaServices' => [ + 'summary' => 'Queries Eureka services.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '17068', + 'abilityTreeNodes' => ['FEATUREmseKQ13CA'], ], 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '标签名字。', - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gray', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '泳道组id。', - 'description' => 'The ID of the lane group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '119', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", - 'type' => 'any', - 'example' => '[{appName:"test",appId:"hkhon1po62@958bba95910341f'."\n" - .'"}]', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstancesId' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'CONTACTINFO', 'title' => ''], + 'UpStatus' => ['description' => 'The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.'."\n", 'type' => 'string', 'example' => '1/1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'mse::2019-05-31::ListAppBySwimmingLaneGroupTags', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"InstancesId\\": [\\n \\"mse-cn-st21ri2****\\"\\n ],\\n \\"Name\\": \\"CONTACTINFO\\",\\n \\"UpStatus\\": \\"1/1\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListEurekaServices', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"[{appName:\\\\\\"test\\\\\\",appId:\\\\\\"hkhon1po62@958bba95910341f\\\\n\\\\\\"}]\\"\\n}","type":"json"}]', - 'title' => 'ListAppBySwimmingLaneGroupTag', ], - 'GetLosslessRuleByApp' => [ - 'summary' => 'Queries the rules for graceful start and shutdown of an application.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListExportZookeeperData' => [ + 'summary' => 'Lists historical data export tasks of a Microservices Engine (MSE) Zookeeper instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -29836,821 +19869,734 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '173262', - 'abilityTreeNodes' => [ - 'FEATUREmse9OTHB7', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'region id, such as cn-hangzhou', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AppName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'Key word of search lossless list', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2d1****', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MSE namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'appId', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522baa***', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '5', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The data returned.'."\n", + 'title' => 'BaseResult>', + 'description' => 'BaseResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => 'appName', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'AppId' => [ - 'title' => 'appId', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@24810bf4364a***', - ], - 'Count' => [ - 'title' => 'instance\'s count of app', - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Enable' => [ - 'title' => 'rule is open or close', - 'description' => 'Indicates whether graceful start is enabled. Valid values:'."\n" + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The ID of the instance'."\n", 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'ExportType' => ['description' => 'The type of the object that is exported. Valid values:'."\n" ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'WarmupTime' => [ - 'description' => 'The prefetching duration. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'DelayTime' => [ - 'description' => 'The registration latency. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'FuncType' => [ - 'title' => 'warmup function type, 2 means f(x)=x^2', - 'description' => 'The slope of the prefetching curve.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Aligned' => [ - 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', - 'description' => 'Indicates whether service registration is complete before readiness probe.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Related' => [ - 'title' => 'K8s\'s HPA is related to warmup or NOT', - 'description' => 'Indicates whether service prefetching is complete before readiness probe.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'LossLessDetail' => [ - 'title' => 'show lossLess offline&online detail', - 'description' => 'Indicates whether online and offline processing details are displayed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Notice' => [ - 'title' => 'enable lossLess offline active notification', - 'description' => 'Indicates whether notification is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', + .'* transactionLog: transaction logs'."\n" + .'* snapshot: snapshots'."\n", 'type' => 'string', 'example' => 'snapshot', 'title' => ''], + 'ContentMap' => ['description' => 'The details of the task.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Extend' => ['description' => 'The extension information that is in the JSON format. The extension information facilitates addition of parameters.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Status' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* CREATE: The task is being created.'."\n" + .'* RUNNING: The task is being executed.'."\n" + .'* FINISH: The task is completed.'."\n" + .'* FAILED: The task failed.'."\n" + .'* EXPIRE: The task has expired.'."\n", 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'KubeoneTaskIds' => ['description' => 'The ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the task was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ExportType\\": \\"snapshot\\",\\n \\"ContentMap\\": \\"{}\\",\\n \\"Extend\\": \\"{}\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"KubeoneTaskIds\\": \\"10\\",\\n \\"Id\\": 1,\\n \\"CreateTime\\": 1631001140913,\\n \\"UpdateTime\\": 1632979237663\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListExportZookeeperData', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListExportZookeeperData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"AppId\\": \\"hkhon1po62@24810bf4364a***\\",\\n \\"Count\\": 1,\\n \\"Enable\\": true,\\n \\"WarmupTime\\": 120,\\n \\"DelayTime\\": 60,\\n \\"FuncType\\": 2,\\n \\"Aligned\\": true,\\n \\"Related\\": false,\\n \\"LossLessDetail\\": true,\\n \\"Notice\\": false\\n }\\n}","type":"json"}]', - 'title' => 'GetLosslessRuleByApp', - 'description' => 'You can call this operation to query the rules for graceful start and shutdown of an application.'."\n" - ."\n" - .'You can query the rules for graceful start and shutdown of an application preferentially by using the AppId parameter.'."\n" - ."\n" - .'If the AppId parameter is left empty, you can use the RegionId, Namespace, and AppName parameters to query the rules for graceful start and shutdown of an application.'."\n", ], - 'ModifyLosslessRule' => [ - 'summary' => 'Modifies configurations of the lossless online and offline feature.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListFlowRules' => [ + 'summary' => 'Obtains a list of throttling rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '115999', - 'abilityTreeNodes' => [ - 'FEATUREmse9OTHB7', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '159811', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => 'regionId', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => 'appName', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'wx-work-api', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'xx-demo', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ResourceSearchKey', 'in' => 'query', - 'schema' => [ - 'title' => 'namespace', - 'description' => 'The microservice namespace to which the rule applies.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'default' => 'default', - ], + 'schema' => ['description' => 'The keyword that is used for the search.'."\n", 'type' => 'string', 'required' => false, 'example' => '/a', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => 'appName', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c644n5frmc@3e75f25fd4*****', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => 'the switch of rule, TRUE means open, FALSE means close', - 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" - ."\n" - .'* `true`: enables the rule.'."\n" - .'* `false`: disables the rule.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - ], - [ - 'name' => 'WarmupTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'warmup time of App', - 'description' => 'The prefetching duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '60', - ], - ], - [ - 'name' => 'DelayTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'delay time of register to registry', - 'description' => 'The registration latency.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'FuncType', - 'in' => 'query', - 'schema' => [ - 'title' => 'warmup function type, 2 means f(x)=x^2', - 'description' => 'The slope of the prefetching curve.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Aligned', - 'in' => 'query', - 'schema' => [ - 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', - 'description' => 'Specifies whether to align the lifecycle of the application in the Kubernetes cluster with that of the microservice.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******', 'title' => ''], ], [ - 'name' => 'Related', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'title' => 'K8s\'s HPA is related to warmup or NOT', - 'description' => 'Specifies whether to associate with service prefetching.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => '/a', 'title' => ''], ], [ - 'name' => 'LossLessDetail', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'title' => 'show lossLess offline&online detail', - 'description' => 'Specifies whether to display online and offline processing details.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Notice', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'enable lossLess offline active notification', - 'description' => 'Specifies whether to enable notification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - 'title' => 'Id of the request', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' The request was successful.'."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' The request failed.'."\n" ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", + .' '."\n", 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'modifyLosslessRule success', + 'title' => '', ], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"modifyLosslessRule success\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - 'title' => 'ModifyLosslessRule', - ], - 'FetchLosslessRuleList' => [ - 'summary' => 'Obtains the rules for graceful start and shutdown.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AppName' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'finance', 'title' => ''], + 'Resource' => ['description' => 'The name of the interface resource.'."\n", 'type' => 'string', 'example' => '/a', 'title' => ''], + 'ResourceType' => ['description' => 'Interface resource type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ControlBehavior' => [ + 'description' => 'The throttling effect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' fast failure'."\n" + ."\n" + .' '."\n" + ."\n" + .'* 2'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' in queue'."\n" + ."\n" + .' '."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['', 2 => ''], + 'example' => '0', + 'title' => '', + ], + 'MaxQueueingTimeMs' => ['description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'Threshold' => ['description' => 'The throttling threshold.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'Enable' => [ + 'description' => 'Indicates whether the throttling rule was enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', + ], + 'AppId' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => 'hkhon1po62@5f1b08becb*****', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region in which the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'FallbackObject' => ['description' => 'The throttling behavior.'."\n", 'type' => 'string', 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', 'title' => ''], + 'MetricType' => ['description' => 'The statistical dimension. The value 1 indicates that the number of accepted requests is used for statistics.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TrafficTags' => ['description' => 'A reserved parameter.'."\n", 'type' => 'object', 'example' => '{\\"origin\\":\\"default\\"}', 'title' => ''], + 'LimitApp' => ['description' => 'Requests source application.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalSize' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 2,\\n \\"AppName\\": \\"finance\\",\\n \\"Resource\\": \\"/a\\",\\n \\"ResourceType\\": 1,\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 10,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"MetricType\\": 1,\\n \\"TrafficTags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 11\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListFlowRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListGateway' => [ + 'summary' => 'Queries a list of gateways.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '24675', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'region id, such as cn-hangzhou', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'AppName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'Key word of search lossless list', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spring-boot-sample', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'OrderItem', 'in' => 'query', - 'schema' => [ - 'title' => 'appId', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hyaziyb6sc@86827c61f5ed8fc', - ], + 'schema' => ['description' => 'The sorting criteria.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'DescSort', 'in' => 'query', - 'schema' => [ - 'title' => 'current', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to sort the results in descending order. This parameter is not currently in use.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'FilterParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'limit', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', + 'description' => 'The filter parameters.', + 'type' => 'object', + 'properties' => [ + 'GatewayType' => ['description' => 'The gateway type.', 'type' => 'string', 'required' => false, 'example' => 'Ingress', 'title' => ''], + 'Name' => ['description' => 'The gateway name.', 'type' => 'string', 'required' => false, 'example' => 'rutain-test', 'title' => ''], + 'Vpc' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp13hhyjntbab7w****', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique gateway ID.', 'type' => 'string', 'required' => false, 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mse_ingresspre-cn-****', 'title' => ''], + 'MseTag' => ['description' => 'The resource tag.', 'type' => 'string', 'required' => false, 'example' => '[{"key":"tagkey","value":"tagvalue"}]', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-7y2uye*****', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'The data returned.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '56D9E600-6348-4260-B35F-583413F****', - 'title' => 'Id of the request', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34300B3-52EC-5049-8C96-914098CF****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '36', - ], - 'Results' => [ - 'description' => 'The returned data.'."\n", + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Result' => [ + 'description' => 'The list of gateways.', 'type' => 'array', 'items' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The details of a gateway.', 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'title' => 'appName', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'echo-demo', - ], - 'AppId' => [ - 'title' => 'appId', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@24810bf4364aea1', - ], - 'Count' => [ - 'title' => 'instance\'s count of app', - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Enable' => [ - 'title' => 'rule is open or close', - 'description' => 'Indicates whether graceful start is enabled. Valid values:'."\n" - ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'WarmupTime' => [ - 'description' => 'The prefetching duration. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', + 'Id' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '153', 'title' => ''], + 'Name' => ['description' => 'The gateway name.', 'type' => 'string', 'example' => 'tesa-test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique gateway ID.', 'type' => 'string', 'example' => 'gw-5017305290e14cebb8ce5cb6a4****', 'title' => ''], + 'GatewayType' => ['description' => 'The gateway type.', 'type' => 'string', 'example' => 'Ingress', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'PrimaryUser' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '18278117654342', 'title' => ''], + 'Status' => ['description' => 'The status of the gateway. Valid values:'."\n" + ."\n" + .'- 0: Creating'."\n" + ."\n" + .'- 1: Creation Failed'."\n" + ."\n" + .'- 2: Running'."\n" + ."\n" + .'- 3: Changing'."\n" + ."\n" + .'- 4: Scaling In'."\n" + ."\n" + .'- 6: Scaling Out'."\n" + ."\n" + .'- 8: Deleting'."\n" + ."\n" + .'- 9: Suspended'."\n" + ."\n" + .'- 10: Restarting'."\n" + ."\n" + .'- 11: Rebuilding'."\n" + ."\n" + .'- 12: Upgrading'."\n" + ."\n" + .'- 13: Upgrade Failed', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'AhasOn' => ['description' => 'Indicates whether Application High Availability Service (AHAS) is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ArmsOn' => ['description' => 'Indicates whether Application Real-Time Monitoring Service (ARMS) is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Spec' => ['description' => 'The specification.', 'type' => 'string', 'example' => 'MSE_GTW_1_2_200_c', 'title' => ''], + 'Replica' => ['description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-09-13 19:24:23', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-09-13 19:24:23', 'title' => ''], + 'StatusDesc' => ['description' => 'The status description.', 'type' => 'string', 'example' => 'Restart', 'title' => ''], + 'Slb' => [ + 'description' => 'The associated SLB instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an SLB instance.', + 'type' => 'object', + 'properties' => [ + 'SlbIp' => ['description' => 'The IP address of the SLB instance.', 'type' => 'string', 'example' => '153.12.XX.XX', 'title' => ''], + 'SlbPort' => ['description' => 'The port of the SLB instance.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'SlbSpec' => ['description' => 'The specification of the SLB instance.', 'type' => 'string', 'example' => 'slb.s2.small', 'title' => ''], + 'Type' => ['description' => 'The network type. Valid values:'."\n" + ."\n" + .'- `PUB_NET`: Internet'."\n" + ."\n" + .'- PRIVATE\\_NET: VPC', 'type' => 'string', 'example' => 'PUB_NET', 'title' => ''], + 'GatewaySlbStatus' => ['description' => 'The status of the associated SLB instance.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + 'StatusDesc' => ['description' => 'The status description.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], + 'GatewaySlbMode' => ['description' => 'The mode of the associated SLB instance.', 'type' => 'string', 'example' => 'UserHost', 'title' => ''], + 'SlbId' => ['description' => 'The ID of the SLB instance.', 'type' => 'string', 'example' => 'lb-bp1ut8asdfgucjk****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], - 'DelayTime' => [ - 'description' => 'The registration latency. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', + 'InternetSlb' => [ + 'description' => 'The Internet-facing SLB instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the Internet-facing SLB instance.', + 'type' => 'object', + 'properties' => [ + 'SlbIp' => ['description' => 'The IP address of the SLB instance.', 'type' => 'string', 'example' => '153.12.XX.XX', 'title' => ''], + 'SlbPort' => ['description' => 'The port of the SLB instance.', 'type' => 'string', 'example' => 'slb.s2.small', 'title' => ''], + 'SlbSpec' => ['description' => 'The specification of the SLB instance.', 'type' => 'string', 'example' => 'slb.s2.small', 'title' => ''], + 'Type' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'PUB_NET', 'title' => ''], + 'InternetNetworkFlow' => ['description' => 'The public network traffic.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'GatewaySlbStatus' => ['description' => 'The status of the associated SLB instance.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + 'StatusDesc' => ['description' => 'The status description.', 'type' => 'string', 'example' => '创建中', 'title' => ''], + 'GatewaySlbMode' => ['description' => 'The mode of the associated SLB instance.', 'type' => 'string', 'example' => 'UserHost', 'title' => ''], + 'SlbId' => ['description' => 'The ID of the SLB instance.', 'type' => 'string', 'example' => 'lb-bp1ut8asdfgucjk****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], - 'FuncType' => [ - 'title' => 'warmup function type, 2 means f(x)=x^2', - 'description' => 'The slope of the prefetching curve.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Aligned' => [ - 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', - 'description' => 'Indicates whether service registration is complete before readiness probe.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Upgrade' => ['description' => 'Indicates whether the gateway can be upgraded.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'MustUpgrade' => ['description' => 'Indicates whether the gateway must be forcibly upgraded.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SupportWasm' => ['description' => 'Indicates whether WebAssembly (Wasm) is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CurrentVersion' => ['description' => 'The current version.', 'type' => 'string', 'example' => '0.1.0-mse-gw', 'title' => ''], + 'AppVersion' => ['description' => 'The application version.', 'type' => 'string', 'example' => '1.0.1.0', 'title' => ''], + 'LatestVersion' => ['description' => 'The latest version.', 'type' => 'string', 'example' => '0.1.0-mse-gw', 'title' => ''], + 'Vswitch2' => ['description' => 'The ID of the secondary vSwitch.', 'type' => 'string', 'example' => 'vsw-bpbrveck45nf****', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'mse_ingresspost-cn-0jbvrcex****', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'EndDate' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '4792060800000', 'title' => ''], + 'Tag' => ['description' => 'The tag of the gateway.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'InitConfig' => [ + 'description' => 'The initialization configurations.', + 'type' => 'object', + 'properties' => [ + 'EnableWaf' => ['description' => 'Indicates whether Web Application Firewall (WAF) is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SupportWaf' => ['description' => 'Indicates whether WAF is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Related' => [ - 'title' => 'K8s\'s HPA is related to warmup or NOT', - 'description' => 'Indicates whether service prefetching is complete before readiness probe.'."\n", - 'type' => 'boolean', - 'example' => 'false', + 'GatewayVersion' => ['description' => 'The gateway version.', 'type' => 'string', 'example' => '1.2.9', 'title' => ''], + 'RollBack' => ['description' => 'Indicates whether rollbacks are supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'MseTag' => ['description' => 'The resource tags.', 'type' => 'string', 'example' => '{"tagKey":"tagValue"}', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-97hg87vi****', 'title' => ''], + 'TotalReplica' => ['description' => 'The total number of replicas, including any auto-scaled replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Elastic' => ['description' => 'Indicates whether auto scaling is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ElasticReplica' => ['description' => 'The number of auto-scaled replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ElasticType' => ['description' => 'The type of auto scaling. Valid value:'."\n" + ."\n" + .'- CronHPA: Time-based scaling', 'type' => 'string', 'example' => 'CronHPA', 'title' => ''], + 'ElasticPolicy' => [ + 'description' => 'The auto scaling policy.', + 'type' => 'object', + 'properties' => [ + 'Elastic' => ['description' => 'Indicates whether auto scaling is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MaxReplica' => ['description' => 'The maximum number of replicas for auto scaling.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'ElasticType' => ['description' => 'The type of auto scaling. Valid value:'."\n" + ."\n" + .'- CronHPA: Scheduled scaling', 'type' => 'string', 'example' => 'CronHPA', 'title' => ''], + 'TimePolicyList' => [ + 'description' => 'The list of scheduled auto scaling policies.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesiredReplica' => ['description' => 'The desired number of replicas for auto scaling.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'StartTime' => ['description' => 'The start time for auto scaling.', 'type' => 'string', 'example' => '07:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time for auto scaling.', 'type' => 'string', 'example' => '09:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LoadWarningThreshold' => ['description' => 'Specifies the threshold type for load-based auto scaling: `true` for the warning threshold and `false` for the safety threshold.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'EnableScaleTimePolicyList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time of the period.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EndTime' => ['description' => 'The end time of the period.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The time periods during which scale-in is allowed.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'LossLessDetail' => [ - 'title' => 'show lossLess offline&online detail', - 'description' => 'Indicates whether online and offline processing details are displayed.'."\n", - 'type' => 'boolean', - 'example' => 'false', + 'ElasticInstanceId' => ['description' => 'The ID of the elastic instance for the gateway. This parameter is returned if auto scaling is enabled.', 'type' => 'string', 'example' => 'mse_ingresselastic_public_cn-uqm3d0*****', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC in which the gateway resides.', 'type' => 'string', 'example' => 'vpc-uf6heojei217tv14*****', 'title' => ''], + 'MseVersion' => ['description' => 'The cluster version.', 'type' => 'string', 'title' => '', 'example' => ''], + 'MaintenancePeriod' => [ + 'type' => 'object', + 'properties' => [ + 'TimeZone' => ['description' => 'The time zone.', 'type' => 'string', 'title' => '', 'example' => ''], + 'StartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The maintenance window.', + 'title' => '', + 'example' => '', ], - 'Notice' => [ - 'title' => 'enable lossLess offline active notification', - 'description' => 'Indicates whether notification is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'GatewayEntry' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NetType' => ['description' => 'The network type of the ingress. Valid values:'."\n" + ."\n" + .'- `PRIVATE_NET`: VPC'."\n" + ."\n" + .'- PUB\\_NET: Internet', 'type' => 'string', 'example' => 'PUB_NET', 'title' => ''], + 'EntryDomain' => ['description' => 'The ingress domain name.', 'type' => 'string', 'example' => 'gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com', 'title' => ''], + 'IpList' => [ + 'type' => 'array', + 'items' => ['description' => 'An ingress IP address.', 'type' => 'string', 'example' => '1.2.3.4', 'title' => ''], + 'description' => 'The ingress IP addresses.', + 'title' => '', + 'example' => '', + ], + 'HttpPorts' => [ + 'type' => 'array', + 'items' => ['description' => 'An HTTP listener port.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'description' => 'The HTTP listener ports.', + 'title' => '', + 'example' => '', + ], + 'HttpsPorts' => [ + 'type' => 'array', + 'items' => ['description' => 'An HTTPS listener port.', 'type' => 'integer', 'format' => 'int32', 'example' => '443', 'title' => ''], + 'description' => 'The HTTPS listener ports.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The ingress configurations for the gateway. This parameter is applicable to Professional Edition instances.', + 'title' => '', + 'example' => '', ], + 'VersionLifecycle' => ['description' => 'The version lifecycle.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34300B3-52EC-5049-8C96-914098CF****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 153,\\n \\"Name\\": \\"tesa-test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebb8ce5cb6a4****\\",\\n \\"GatewayType\\": \\"Ingress\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"18278117654342\\",\\n \\"Status\\": 2,\\n \\"AhasOn\\": false,\\n \\"ArmsOn\\": false,\\n \\"Spec\\": \\"MSE_GTW_1_2_200_c\\",\\n \\"Replica\\": 2,\\n \\"GmtCreate\\": \\"2021-09-13 19:24:23\\",\\n \\"GmtModified\\": \\"2021-09-13 19:24:23\\",\\n \\"StatusDesc\\": \\"Restart\\",\\n \\"Slb\\": [\\n {\\n \\"SlbIp\\": \\"153.12.XX.XX\\",\\n \\"SlbPort\\": \\"80\\",\\n \\"SlbSpec\\": \\"slb.s2.small\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"Creating\\",\\n \\"GatewaySlbMode\\": \\"UserHost\\",\\n \\"SlbId\\": \\"lb-bp1ut8asdfgucjk****\\"\\n }\\n ],\\n \\"InternetSlb\\": [\\n {\\n \\"SlbIp\\": \\"153.12.XX.XX\\",\\n \\"SlbPort\\": \\"slb.s2.small\\",\\n \\"SlbSpec\\": \\"slb.s2.small\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"InternetNetworkFlow\\": \\"20\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"创建中\\",\\n \\"GatewaySlbMode\\": \\"UserHost\\",\\n \\"SlbId\\": \\"lb-bp1ut8asdfgucjk****\\"\\n }\\n ],\\n \\"Upgrade\\": false,\\n \\"MustUpgrade\\": false,\\n \\"SupportWasm\\": true,\\n \\"CurrentVersion\\": \\"0.1.0-mse-gw\\",\\n \\"AppVersion\\": \\"1.0.1.0\\",\\n \\"LatestVersion\\": \\"0.1.0-mse-gw\\",\\n \\"Vswitch2\\": \\"vsw-bpbrveck45nf****\\",\\n \\"InstanceId\\": \\"mse_ingresspost-cn-0jbvrcex****\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"EndDate\\": \\"4792060800000\\",\\n \\"Tag\\": \\"test\\",\\n \\"InitConfig\\": {\\n \\"EnableWaf\\": true,\\n \\"SupportWaf\\": true\\n },\\n \\"GatewayVersion\\": \\"1.2.9\\",\\n \\"RollBack\\": false,\\n \\"MseTag\\": \\"{\\\\\\"tagKey\\\\\\":\\\\\\"tagValue\\\\\\"}\\",\\n \\"ResourceGroupId\\": \\"rg-97hg87vi****\\",\\n \\"TotalReplica\\": 4,\\n \\"Elastic\\": true,\\n \\"ElasticReplica\\": 2,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"ElasticPolicy\\": {\\n \\"Elastic\\": true,\\n \\"MaxReplica\\": 10,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"TimePolicyList\\": [\\n {\\n \\"DesiredReplica\\": 4,\\n \\"StartTime\\": \\"07:00\\",\\n \\"EndTime\\": \\"09:00\\"\\n }\\n ],\\n \\"LoadWarningThreshold\\": false,\\n \\"EnableScaleTimePolicyList\\": [\\n {\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n }\\n ]\\n },\\n \\"ElasticInstanceId\\": \\"mse_ingresselastic_public_cn-uqm3d0*****\\",\\n \\"VpcId\\": \\"vpc-uf6heojei217tv14*****\\",\\n \\"MseVersion\\": \\"\\",\\n \\"MaintenancePeriod\\": {\\n \\"TimeZone\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n },\\n \\"GatewayEntry\\": [\\n {\\n \\"NetType\\": \\"PUB_NET\\",\\n \\"EntryDomain\\": \\"gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com\\",\\n \\"IpList\\": [\\n \\"1.2.3.4\\"\\n ],\\n \\"HttpPorts\\": [\\n 80\\n ],\\n \\"HttpsPorts\\": [\\n 443\\n ]\\n }\\n ],\\n \\"VersionLifecycle\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGateway', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 36,\\n \\"Results\\": [\\n {\\n \\"AppName\\": \\"echo-demo\\",\\n \\"AppId\\": \\"hkhon1po62@24810bf4364a***\\",\\n \\"Count\\": 3,\\n \\"Enable\\": true,\\n \\"WarmupTime\\": 60,\\n \\"DelayTime\\": 60,\\n \\"FuncType\\": 2,\\n \\"Aligned\\": true,\\n \\"Related\\": false,\\n \\"LossLessDetail\\": false,\\n \\"Notice\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'FetchLosslessRuleList', - 'description' => 'You can call this operation to query the rules for graceful start and shutdown.'."\n", + 'translator' => 'machine', ], - 'GetLocalityRule' => [ - 'summary' => 'Obtains the Intra-zone Provider First rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayAuthConsumer' => [ + 'summary' => 'Queries the list of consumers on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -30658,388 +20604,304 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '45915', - 'abilityTreeNodes' => [ - 'FEATUREmseZ3XXPX', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-0fe488252dc44d55a9dd57875193****', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The name of the consumer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", 'type' => 'string', 'required' => false, 'example' => 'JWT', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'ConsumerStatus', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgxznfcvbe@be2c0228f******', - ], + 'schema' => ['description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D3971C60-3F07-58B0-8EA0-A194********', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'dc63-465d-8ef5-20dc18af****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "pageNumber":0,'."\n" - .' "namespaceId":"cn-hangzhou",'."\n" - .' "enable":false,'."\n" - .' "appId":"hkhon1po62@3aa3582********",'."\n" - .' "pageSize":0,'."\n" - .' "region":"cn-hangzhou",'."\n" - .' "routeRules":['."\n" - .' {'."\n" - .' "threshold":0.2,'."\n" - .' "tags":[]'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Result' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the consumer.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ConsumerStatus' => ['description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'PrimaryUser' => ['description' => 'The creator.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'Type' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", 'type' => 'string', 'example' => 'JWT', 'title' => ''], + 'Description' => ['description' => 'The description of the consumer.'."\n", 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2021-09-13 19:24:23', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"ConsumerStatus\\": true,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"Type\\": \\"JWT\\",\\n \\"Description\\": \\"Description\\",\\n \\"GmtCreate\\": \\"2021-09-13 19:24:23\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayAuthConsumer', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"D3971C60-3F07-58B0-8EA0-A194********\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"pageNumber\\\\\\":0,\\\\n \\\\\\"namespaceId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"enable\\\\\\":false,\\\\n \\\\\\"appId\\\\\\":\\\\\\"hkhon1po62@3aa3582********\\\\\\",\\\\n \\\\\\"pageSize\\\\\\":0,\\\\n \\\\\\"region\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"routeRules\\\\\\":[\\\\n {\\\\n \\\\\\"threshold\\\\\\":0.2,\\\\n \\\\\\"tags\\\\\\":[]\\\\n }\\\\n ]\\\\n}\\",\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'GetLocalityRule', ], - 'UpdateLocalityRule' => [ - 'summary' => 'Updates the Intra-zone Provider First rules.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayAuthConsumerResource' => [ + 'summary' => 'Queries the list of authorized resources for the consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myNamespace', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The name of the route.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'ResourceStatus', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['description' => 'The resource authorization status. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Rules', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], - ], - [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.2', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '78F05E89-D387-50CE-8186-2E27A8AB****', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "Message":"updateLocalityPolicy success",'."\n" - .' "RequestId":"3B519913-7348-16AB-AD71-******",'."\n" - .' "HttpStatusCode":200,'."\n" - .' "Code":200,'."\n" - .' "Success":true'."\n" - .'}', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Result' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the authorized resource for the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ConsumerId' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'RouteId' => ['description' => 'The ID of the route.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3091', 'title' => ''], + 'RouteName' => ['description' => 'The name of the route.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ResourceStatus' => ['description' => 'The resource authorization status. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"ConsumerId\\": 2,\\n \\"RouteId\\": 3091,\\n \\"RouteName\\": \\"test\\",\\n \\"ResourceStatus\\": true,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayAuthConsumerResource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListGatewayAuthConsumerResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"78F05E89-D387-50CE-8186-2E27A8AB****\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"Message\\\\\\":\\\\\\"updateLocalityPolicy success\\\\\\",\\\\n \\\\\\"RequestId\\\\\\":\\\\\\"3B519913-7348-16AB-AD71-******\\\\\\",\\\\n \\\\\\"HttpStatusCode\\\\\\":200,\\\\n \\\\\\"Code\\\\\\":200,\\\\n \\\\\\"Success\\\\\\":true\\\\n}\\",\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'UpdateLocalityRule', ], - 'GetApplicationList' => [ - 'summary' => 'Obtains the list of applications.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayCircuitBreakerRule' => [ + 'summary' => 'Queries the circuit breaker rules of the gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -31047,907 +20909,534 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17022', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of an application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rest-container', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of an application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hkhon1po62@c3df23522b*****', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source of the application. The value is fixed as edasmsc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => 'The programming language of the application, such as Java and Go.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Java', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'SwitchEnable', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to enable switching.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'SentinelEnable', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to enable the Sentinel-compatible mode.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - 'default' => 'default', - ], - ], - [ - 'name' => 'Tags', + 'name' => 'FilterParams', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - 'maxItems' => 20, - ], + 'schema' => ['title' => 'just for POP', 'description' => 'just for POP', 'type' => 'string', 'required' => true, 'example' => 'param'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F55E608F-7C15-****-9CFD-DF832EBC4A0F', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the instance list', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalSize' => ['description' => 'The total number of instances queried', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '11'], + 'PageSize' => ['description' => 'The number of rows per page set during input', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], 'Result' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The returned collection.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExtraInfo' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'finance', - ], - 'AppId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@5f1b08becb*****', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '1234567890', - ], - 'InstancesNumber' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Source' => [ - 'description' => 'The source of the application.'."\n", - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'Language' => [ - 'description' => 'The programming language of the application.'."\n", - 'type' => 'string', - 'example' => 'JAVA', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => 'The microservice namespace to which the application belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Tags' => [ - 'type' => 'object', + 'Id' => ['description' => 'The circuit breaker rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '467', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11919', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'RouteId' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3091', 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'routeName', 'title' => ''], + 'Strategy' => ['description' => 'The threshold pattern.'."\n" + ."\n" + .'0: Slow call pattern.'."\n" + ."\n" + .'1: Exception pattern.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TriggerRatio' => ['description' => 'The percentage to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'StatDurationSec' => ['description' => 'The circuit breaking statistics duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'RecoveryTimeoutSec' => ['description' => 'The circuit breaking recovery duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'MinRequestAmount' => ['description' => 'The minimum number of requests to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxAllowedMs' => ['description' => 'The slow call threshold in slow call pattern.', 'type' => 'integer', 'format' => 'int32', 'example' => '14', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: Single machine.'."\n" + ."\n" + .'1: Cluster.'."\n" + ."\n" + .'2: Cluster to single machine.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The Web fallback behavior type.'."\n" + ."\n" + .'0: Return specified content.'."\n" + ."\n" + .'1: Redirect to a specified page.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: Plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '204', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP response text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirect URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'The custom header, input as key-value pairs.', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Whether to enable.'."\n" + ."\n" + .'0: Not enabled.'."\n" + ."\n" + .'1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The filter rule id', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '467', 'title' => ''], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalSize' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'Results' => [ + 'title' => '', + 'description' => 'The returned result collection.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned collection.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The circuit breaker rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '467', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11919', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-1ee34548c68f4778a25c05abd657****', 'title' => ''], + 'RouteId' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3450', 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'routeName', 'title' => ''], + 'Strategy' => ['description' => 'The threshold pattern.'."\n" + ."\n" + .'0: Slow call pattern.'."\n" + ."\n" + .'1: Exception pattern.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TriggerRatio' => ['description' => 'The percentage to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'StatDurationSec' => ['description' => 'The circuit breaking statistics duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'RecoveryTimeoutSec' => ['description' => 'The circuit breaking recovery duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'MinRequestAmount' => ['description' => 'The minimum number of requests to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxAllowedMs' => ['description' => 'The slow call threshold in slow call pattern.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: Single machine.'."\n" + ."\n" + .'1: Cluster.'."\n" + ."\n" + .'2: Cluster to single machine.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The Web fallback behavior type.'."\n" + ."\n" + .'0: Return specified content'."\n" + ."\n" + .'1: Redirect to a specified page', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: Plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '204', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP response text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirect URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'The custom header, input as key-value pairs.', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Whether to enable.'."\n" + ."\n" + .'0: Not enabled.'."\n" + ."\n" + .'1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The filter rule id', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '467', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 11,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 467,\\n \\"GatewayId\\": 11919,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"RouteId\\": 3091,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 14,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 204,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 467\\n ]\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 467,\\n \\"GatewayId\\": 11919,\\n \\"GatewayUniqueId\\": \\"gw-1ee34548c68f4778a25c05abd657****\\",\\n \\"RouteId\\": 3450,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 204,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 467\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayCircuitBreakerRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"F55E608F-7C15-****-9CFD-DF832EBC4A0F\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Status\\": 0,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"AppName\\": \\"finance\\",\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"InstancesNumber\\": 1,\\n \\"Source\\": \\"edasmsc\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\",\\n \\"Tags\\": {\\n \\"tagKey1\\": \\"tagValue1\\",\\n \\"tagKey2\\": \\"tagValue2\\"\\n }\\n }\\n ],\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'GetApplicationList', ], - 'CreateMseServiceApplication' => [ - 'summary' => 'Creates an application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayDomain' => [ + 'summary' => 'Queries the list of domains associated with a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '35641', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'bsd-xxyp-open-goods-server', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region where the instance resides. Examples:'."\n" - ."\n" - .'* cn-hangzhou: China (Hangzhou)'."\n" - .'* cn-beijing: China (Beijing)'."\n" - .'* cn-shanghai: China (Shanghai)'."\n" - .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" - .'* cn-shenzhen: China (Shenzhen)'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service source.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'edasmsc', - 'default' => 'edasmsc', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => 'The programming language of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'JAVA', - ], - ], - [ - 'name' => 'ExtraInfo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{}', - ], - ], - [ - 'name' => 'SentinelEnable', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to enable the Sentinel-compatible mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'title' => ''], ], [ - 'name' => 'SwitchEnable', + 'name' => 'Type', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to enable switching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The domain type.', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''], ], [ - 'name' => 'MseVersion', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" - ."\n" - .'* mse_pro: Professional Edition.'."\n" - .'* mse_dev: Developer Edition.', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => 'Fuzzy search by domain name', 'type' => 'string', 'example' => 'example.com', 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '904F6C04-1284-****-8ED2-FFC57E507A72', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3F5D8E93-CA66-57F1-8BCF-A223E11B6B91'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'The request result, which can be:'."\n" + ."\n" + .'- `true`: The request is successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status. Valid values: 1: available; 2: deleted.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExtraInfo' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'UpdateTime' => [ - 'description' => 'The last modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', - ], - 'LicenseKey' => [ - 'description' => 'The license key in use.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '1234567890', - ], - 'Source' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'Language' => [ - 'description' => 'The programming language of the application.'."\n", - 'type' => 'string', - 'example' => 'JAVA', - ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Version' => [ - 'description' => 'The version information.'."\n", - 'type' => 'string', - 'example' => '1.0.0', + 'description' => 'The node data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The domain ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '243', 'title' => ''], + 'Name' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'Protocol' => ['description' => 'The protocol.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'MustHttps' => ['description' => 'Indicates whether HTTPS is enforced.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CertIdentifier' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => '3452-cn-hangzhou', 'title' => ''], + 'CertBeforeDate' => ['description' => 'The certificate expiration time (deprecated, please check it on the domain product page).', 'type' => 'string', 'example' => ' 2031-03-30 02:35:12', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the domain record was created.', 'type' => 'string', 'example' => ' 2031-03-30 02:35:12', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the domain record was updated.', 'type' => 'string', 'example' => ' 2031-03-30 02:35:12', 'title' => ''], + 'Status' => ['description' => 'The domain status.'."\n" + .'Enumeration values'."\n" + ."\n" + .'- 0 Unpublished'."\n" + ."\n" + .'- 2 Publishing'."\n" + ."\n" + .'- 3 Published'."\n" + ."\n" + .'- 4 Editing'."\n" + ."\n" + .'- 5 Unpublishing'."\n" + ."\n" + .'- 6 Inactive', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Type' => ['description' => 'The domain source type:'."\n" + ."\n" + .'- Op: Created from console'."\n" + ."\n" + .'- Ingress: Created from MSE Ingress', 'type' => 'string', 'example' => 'Op', 'title' => ''], + 'Comment' => [ + 'description' => 'The routing comment (ingress)', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status', 'type' => 'string', 'example' => 'Error', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Http2' => ['description' => 'Indicates whether `Http2` is enabled.'."\n" + ."\n" + .'- `open`: `Http2` is enabled.'."\n" + ."\n" + .'- `close`: `Http2` is disabled.'."\n" + ."\n" + .'- `globalConfig`: Use global configuration.', 'type' => 'string', 'example' => 'close', 'title' => ''], + 'TlsMax' => ['description' => 'The maximum TLS version.', 'type' => 'string', 'example' => 'TLS 1.3', 'title' => ''], + 'TlsMin' => ['description' => 'The minimum TLS version.', 'type' => 'string', 'example' => 'TLS 1.0', 'title' => ''], + 'IsManaged' => ['description' => 'Indicates whether it is a managed domain', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'mse::2019-05-31::CreateApplication', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F5D8E93-CA66-57F1-8BCF-A223E11B6B91\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 243,\\n \\"Name\\": \\"test.com\\",\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"3452-cn-hangzhou\\",\\n \\"CertBeforeDate\\": \\" 2031-03-30 02:35:12\\",\\n \\"GatewayId\\": 12,\\n \\"GmtCreate\\": \\" 2031-03-30 02:35:12\\",\\n \\"GmtModified\\": \\" 2031-03-30 02:35:12\\",\\n \\"Status\\": 3,\\n \\"Type\\": \\"Op\\",\\n \\"Comment\\": {\\n \\"Status\\": \\"Error\\"\\n },\\n \\"Http2\\": \\"close\\",\\n \\"TlsMax\\": \\"TLS 1.3\\",\\n \\"TlsMin\\": \\"TLS 1.0\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewayDomain', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"904F6C04-1284-****-8ED2-FFC57E507A72\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"UpdateTime\\": 1632979237663,\\n \\"LicenseKey\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"CreateTime\\": 1631001140913,\\n \\"AppId\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'CreateMseServiceApplication', ], - 'CreateApplication' => [ - 'summary' => 'Creates an application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayFlowRule' => [ + 'summary' => 'Queries the gateway throttle rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '17001', - 'abilityTreeNodes' => [ - 'FEATUREmse3O985H', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'FilterParams', 'in' => 'query', - 'schema' => [ - 'title' => '地域。', - 'description' => 'The region to which the application belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'just for POP', 'description' => 'just for POP', 'type' => 'string', 'required' => true, 'example' => 'param'], ], [ - 'name' => 'Namespace', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => 'MSE命名空间名字。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名。', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service where the application is deployed. A value of ACK indicates Container Service for Kubernetes.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ACK', - 'default' => 'edasmsc', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => 'The programming language of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'JAVA', - 'default' => 'JAVA', - ], - ], - [ - 'name' => 'SentinelEnable', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to start the switch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'SwitchEnable', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - 'minItems' => 0, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '68D91223-CCE9-5F9C-B538-20F617DA48B1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0951EBF0-798E-5E0B-8D38-460A14AD****', 'title' => ''], 'Data' => [ - 'description' => 'The data of the node.'."\n", + 'description' => 'The Meta return information.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the application. A value of 1 indicates that the application is in a normal state.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExtraInfo' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => '{\\"rpcTypes\\":[\\"dubbo\\",\\"springCloud\\"]}', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'UpdateTime' => [ - 'description' => 'The update time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', - ], - 'LicenseKey' => [ - 'description' => 'The license key in use.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'AppId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'UserId' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1888888888', - ], - 'Source' => [ - 'description' => 'The service where the application is deployed. Valid values:'."\n" - ."\n" - .'* \\- ACK: Container Service for Kubernetes'."\n" - .'* \\- Normal: another service'."\n", - 'type' => 'string', - 'example' => 'ACK', - ], - 'Language' => [ - 'description' => 'The programming language of the application.'."\n", - 'type' => 'string', - 'example' => 'JAVA', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => 'MSE命名空间名字。', - 'type' => 'string', - 'example' => 'prod', + 'PageNumber' => ['description' => 'The page number of the instance list.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalSize' => ['description' => 'The total number of instances queried.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of rows per page set during input.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Result' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned collection.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The routing throttle rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique gateway identity ID.', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], + 'RouteId' => ['description' => 'The routing ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48811', 'title' => ''], + 'RouteName' => ['description' => 'The routing name.', 'type' => 'string', 'example' => 'routeA', 'title' => ''], + 'Threshold' => ['description' => 'The overall QPS threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'BehaviorType' => ['description' => 'The Web fallback behavior type.'."\n" + ."\n" + .'0: Return specified content'."\n" + ."\n" + .'1: Redirect to specified page', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: Plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '429', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP response text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirect URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'0: Disabled.'."\n" + ."\n" + .'1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Version' => [ - 'description' => '版本号。', - 'type' => 'string', - 'example' => '1.0.0', + 'Results' => [ + 'title' => '', + 'description' => 'The paged data collection.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned collection.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The routing throttle rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique gateway identity ID.', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], + 'RouteId' => ['description' => 'The routing ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48811', 'title' => ''], + 'RouteName' => ['description' => 'The routing name.', 'type' => 'string', 'example' => 'routeA', 'title' => ''], + 'Threshold' => ['description' => 'The overall QPS threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'StatDurationMs' => ['description' => 'The statistics duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: Single machine.'."\n" + ."\n" + .'1: Cluster.'."\n" + ."\n" + .'2: Cluster to single machine.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The Web fallback behavior type.'."\n" + ."\n" + .'0: Return specified content'."\n" + ."\n" + .'1: Redirect to specified page', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: Plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '429', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP response text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirect URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'The custom headers, entered as key-value pairs.', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'0: Disabled.'."\n" + ."\n" + .'1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The filtered rule IDs.', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'example' => 'data', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0951EBF0-798E-5E0B-8D38-460A14AD****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"Enable\\": 0\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"StatDurationMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 549\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"68D91223-CCE9-5F9C-B538-20F617DA48B1\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"ExtraInfo\\": \\"{\\\\\\\\\\\\\\"rpcTypes\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dubbo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"springCloud\\\\\\\\\\\\\\"]}\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"UpdateTime\\": 1632979237663,\\n \\"LicenseKey\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"CreateTime\\": 1631001140913,\\n \\"AppId\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"UserId\\": \\"1888888888\\",\\n \\"Source\\": \\"ACK\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"prod\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'CreateApplication', ], - 'GetOverview' => [ - 'summary' => 'Queries overview information about Microservices Governance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayIsolationRule' => [ + 'summary' => 'Queries the gateway concurrency rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -31955,303 +21444,186 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query time. Unit: days. For example, if you set this parameter to 30, the governance rules within the last 30 days are queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Region', + 'name' => 'FilterParams', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'just for POP', 'description' => 'just for POP', 'type' => 'string', 'required' => true, 'example' => 'param'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F025D43-8632-5716-AE9B-7EDDF16C****', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'string', - 'example' => 'data', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the instance list', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalSize' => ['description' => 'The total number of instances queried', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of rows per page set during input', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned collection.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The concurrency rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '358', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique identity ID of the gateway.', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], + 'RouteId' => ['description' => 'The routing ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '52853', 'title' => ''], + 'RouteName' => ['description' => 'The routing name.', 'type' => 'string', 'example' => 'routeName', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The overall concurrency threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: Single machine'."\n" + ."\n" + .'1: Cluster'."\n" + ."\n" + .'2: Cluster to single machine', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The Web fallback behavior type.'."\n" + ."\n" + .'0: Return specified content.'."\n" + ."\n" + .'1: Redirect to a specified page.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: Plain text.'."\n" + ."\n" + .'1: JSON.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '429', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP response text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirect URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'Custom headers, input as key-value pairs', 'type' => 'string', 'example' => 'key:value', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'0: Disabled.'."\n" + ."\n" + .'1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The filtered rule IDs', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '358', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Results' => [ + 'title' => '', + 'description' => 'The returned result set.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned collection.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The concurrency rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '358', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique identity ID of the gateway.', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], + 'RouteId' => ['description' => 'The routing ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '52853', 'title' => ''], + 'RouteName' => ['description' => 'The routing name.', 'type' => 'string', 'example' => 'routeName', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The overall concurrency threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion type.'."\n" + ."\n" + .'0: Single machine.'."\n" + ."\n" + .'1: Cluster.'."\n" + ."\n" + .'2: Single machine to cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BehaviorType' => ['description' => 'The Web fallback behavior type.'."\n" + ."\n" + .'0: Return specified content.'."\n" + ."\n" + .'1: Redirect to a specified page.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: Plain text.'."\n" + ."\n" + .'1: JSON.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '429', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP response text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirect URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'Custom headers, input as key-value pairs', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'0: Disabled.'."\n" + ."\n" + .'1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The filtered rule IDs', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '358', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": \\"data\\",\\n \\"Code\\": 1,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'GetOverview', - 'description' => 'You can call this operation to query overview information about service governance.'."\n", - ], - 'RemoveApplication' => [ - 'summary' => 'Deletes a single application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17086', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'parameters' => [ - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'title' => '地域。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '微服务命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'prod', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '要删除的应用名字。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-app', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '要删除的应用id。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'abcde@12345', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F025D43-8632-5716-AE9B-7EDDF16C****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key:value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 1,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayIsolationRule', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '', - 'type' => 'string', - 'example' => 'abcde-12345', - ], - 'Success' => [ - 'title' => '是否成功。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '', - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Message' => [ - 'title' => '错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'title' => '删除执行结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcde-12345\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'RemoveApplication', ], - 'GetApplicationInstanceList' => [ - 'summary' => 'Queries the list of microservice application instances.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayRoute' => [ + 'summary' => 'Queries the gateway route list.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -32261,241 +21633,428 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '17021', - 'abilityTreeNodes' => [ - 'FEATUREmseZB84VG', - ], + 'abilityTreeCode' => '25969', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名字。', - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 100, - ], - ], - [ - 'name' => 'AppId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '应用Id。', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => true, - 'example' => 'abcde@12345', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '节点标签。', - 'description' => 'The tags that you want to add to nodes.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gray', - ], + 'schema' => ['description' => 'Number of instances displayed per page (currently not in effect, queries all instances by default).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'OrderItem', 'in' => 'query', - 'schema' => [ - 'title' => '第几页。从1开始。', - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Sorting property.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreate', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DescSort', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'Sorting. This field is currently unavailable and being deprecated.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'FilterParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '所在地域。', - 'description' => 'The region.'."\n", - 'type' => 'string', + 'description' => 'Filter conditions in the format {"key1":"value1"}', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['description' => 'Gateway ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81', 'title' => ''], + 'Name' => ['description' => 'Route name', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Status' => ['description' => 'Route status:'."\n" + ."\n" + .'- Unpublished: 0'."\n" + ."\n" + .'- Publishing: 2'."\n" + ."\n" + .'- Published: 3'."\n" + ."\n" + .'- Editing (updates not published): 4'."\n" + ."\n" + .'- Unpublishing: 5'."\n" + ."\n" + .'- Unavailable: 6', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'DefaultServiceId' => ['description' => 'Default service ID', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'title' => '', 'required' => false, 'example' => '1'], + 'RouteOrder' => ['description' => 'Order (unused)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'DomainId' => ['description' => 'Domain ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '284', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'Gateway unique identifier ID', 'type' => 'string', 'required' => true, 'example' => 'gw-30a0106924c94bca8712ec4e79fc5acc', 'title' => ''], + 'DomainName' => ['description' => 'Associated domain', 'type' => 'string', 'required' => false, 'example' => '*.alites.com', 'title' => ''], + 'Path' => ['description' => 'Route path', 'type' => 'string', 'example' => '/test', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Language type for returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '83F02EAB-ECDF-55C6-B332-8649E5E7AF2C'], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'Code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Request result, with the following values:'."\n" + ."\n" + .'- `true`: The request is successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned data.'."\n", + 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ + 'TotalSize' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'title' => ''], + 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Result' => [ - 'title' => '节点列表。', - 'description' => 'The queried nodes.'."\n", + 'description' => 'Data structure.', 'type' => 'array', 'items' => [ - 'title' => '微服务治理节点列表。', - 'description' => '', + 'description' => 'Return collection.', 'type' => 'object', 'properties' => [ - 'Ip' => [ - 'title' => '节点ip。', - 'description' => 'The node IP address.'."\n", - 'type' => 'string', - 'example' => '10.1.2.3', - ], - 'Tags' => [ - 'title' => '节点标签。', - 'description' => 'The node tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '节点标签结构。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Tag' => [ - 'title' => '标签值。', - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'gray', - ], - ], - ], - ], - 'Port' => [ - 'title' => '应用端口。', - 'description' => 'The application port.'."\n", - 'type' => 'string', - 'example' => '8080', + 'Id' => ['description' => 'Route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '47', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'Gateway unique identifier.', 'type' => 'string', 'example' => 'gw-cf0e7f52ecc7429dbc7ba4d5e3656100', 'title' => ''], + 'GatewayId' => ['description' => 'Gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '496', 'title' => ''], + 'Status' => ['description' => 'Status.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RouteOrder' => ['description' => 'Order', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DefaultServiceName' => ['description' => 'Default service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DefaultServiceId' => ['description' => 'Default service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Predicates' => ['description' => 'Matching rules', 'type' => 'string', 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/rpc/compute \\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":true}}', 'title' => ''], + 'RoutePredicates' => [ + 'description' => 'Matching rules', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'Route Path matching.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'Node path.', 'type' => 'string', 'example' => '/getIp', 'title' => ''], + 'Type' => ['description' => 'Matching type.', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + 'IgnoreCase' => ['description' => 'Case insensitive', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'MethodPredicates' => [ + 'description' => 'HTTP method matching', + 'type' => 'array', + 'items' => ['description' => 'Method', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'HeaderPredicates' => [ + 'description' => 'Header matching', + 'type' => 'array', + 'items' => [ + 'description' => 'Header list', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Header KEY', 'type' => 'string', 'example' => 'userid', 'title' => ''], + 'Value' => ['description' => 'Matching value', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'Matching type', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'QueryPredicates' => [ + 'description' => 'Parameter matching', + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter list', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Parameter name', 'type' => 'string', 'example' => 'userid', 'title' => ''], + 'Value' => ['description' => 'Matching value', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'Matching type', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'GmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2022-01-25T07:14:01.817+0000', 'title' => ''], + 'GmtModified' => ['description' => 'Modification time', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'Services' => ['description' => 'Service.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'RouteServices' => [ + 'description' => 'Service.', + 'type' => 'array', + 'items' => [ + 'description' => 'Service list', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'Service ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1563', 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'hu', 'title' => ''], + 'Percent' => ['description' => 'Weight percentage', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'Version' => ['description' => 'Service version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SourceType' => ['description' => 'Source type', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'GroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => 'api', 'title' => ''], + 'AgreementType' => ['description' => 'Protocol Type.', 'type' => 'string', 'example' => 'DUBBO', 'title' => ''], + 'HttpDubboTranscoder' => [ + 'description' => 'Dubbo protocol conversion body.', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'Dubbo service name.', 'type' => 'string', 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', 'title' => ''], + 'DubboServiceVersion' => ['description' => 'Dubbo service version.', 'type' => 'string', 'example' => '0.0.0', 'title' => ''], + 'MothedMapList' => [ + 'description' => 'Dubbo forwarding rule list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Method mapping body.', + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'Dubbo method name.', 'type' => 'string', 'example' => 'sayHello', 'title' => ''], + 'HttpMothed' => ['description' => 'Http method.'."\n" + ."\n" + .'> Supported HTTP method parameter values.'."\n" + .'>'."\n" + .'> - ALL\\_GET'."\n" + .'>'."\n" + .'> - ALL\\_POST'."\n" + .'>'."\n" + .'> - ALL\\_PUT'."\n" + .'>'."\n" + .'> - ALL\\_DELETE'."\n" + .'>'."\n" + .'> - ALL\\_PATCH', 'type' => 'string', 'example' => 'ALL_GET', 'title' => ''], + 'Mothedpath' => ['description' => 'Method matching path.', 'type' => 'string', 'example' => '/mytestzbk/sayhello', 'title' => ''], + 'PassThroughAllHeaders' => ['description' => 'Header pass-through type.'."\n" + ."\n" + .'> Pass-through type enumeration values.'."\n" + .'>'."\n" + .'> - Pass through all: PASS\\_ALL'."\n" + .'>'."\n" + .'> - No pass-through: PASS\\_NOT'."\n" + .'>'."\n" + .'> - Specified parameters: PASS\\_ASSIGN', 'type' => 'string', 'example' => 'PASS_NOT', 'title' => ''], + 'PassThroughList' => [ + 'description' => 'Specified pass-through Header list.', + 'type' => 'array', + 'items' => ['description' => 'Specified Header pass-through value.', 'type' => 'string', 'example' => 'x-forward', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ParamMapsList' => [ + 'description' => 'Parameter mapping list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter mapping body.', + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => 'Input parameter position.'."\n" + ."\n" + .'> Input parameter position enumeration values.'."\n" + .'>'."\n" + .'> - Request parameter: `ALL_QUERY_PARAMETER`'."\n" + .'>'."\n" + .'> - Request header: `ALL_HEADER`'."\n" + .'>'."\n" + .'> - Request path: `ALL_PATH`'."\n" + .'>'."\n" + .'> - Request body: `ALL_BODY`', 'type' => 'string', 'example' => 'ALL_QUERY_PARAMETER', 'title' => ''], + 'ExtractKey' => ['description' => 'Extract key from input.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'MappingType' => ['description' => 'Backend parameter type.', 'type' => 'string', 'example' => 'java.lang.String', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DubboServiceGroup' => ['description' => 'Dubbo service group.', 'type' => 'string', 'example' => 'service group', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ServicePort' => ['description' => 'Service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '20880', 'title' => ''], + 'HealthStatus' => ['description' => 'Health status'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', 'type' => 'string', 'example' => 'Health', 'title' => ''], + 'UnhealthyEndpoints' => [ + 'type' => 'array', + 'items' => ['description' => 'Unhealthy Endpoint', 'type' => 'string', 'example' => '192.168.1.2', 'title' => ''], + 'description' => 'Unhealthy Endpoint list', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DomainId' => ['description' => 'Domain ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '265', 'title' => ''], + 'DomainName' => ['description' => 'Domain name.', 'type' => 'string', 'example' => 'y.com', 'title' => ''], + 'DestinationType' => ['description' => 'Destination type.', 'type' => 'string', 'example' => 'Single', 'title' => ''], + 'DirectResponse' => [ + 'description' => 'Mock configuration', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Body' => ['description' => 'Mock return value', 'type' => 'string', 'example' => 'hello', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DomainIdList' => [ + 'description' => 'Domain list.', + 'type' => 'array', + 'items' => ['description' => 'Domain ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DomainNameList' => [ + 'description' => 'Domain name list.', + 'type' => 'array', + 'items' => ['description' => 'Domain name', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Redirect' => [ + 'description' => 'Redirection', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Host' => ['description' => 'Redirect hostname', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'Path' => ['description' => 'Path.', 'type' => 'string', 'example' => '/test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Type' => ['description' => 'Route type', 'type' => 'string', 'example' => 'Op', 'title' => ''], + 'Comment' => [ + 'description' => 'Route comment (ingress)', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Status.', 'type' => 'string', 'example' => 'error', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EnableWaf' => ['description' => 'Whether to enable WAF', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Fallback' => ['description' => 'Whether to enable Fallback service.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FallbackServices' => [ + 'description' => 'Fallback service.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '353'."\n", 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'service name', 'title' => ''], + 'Percent' => ['description' => 'Weight percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Version' => ['description' => 'Service version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'SourceType' => ['description' => 'Source type.', 'type' => 'string', 'example' => 'MSE'."\n", 'title' => ''], + 'Namespace' => ['description' => 'Service namespace.', 'type' => 'string', 'example' => 'Namespace', 'title' => ''], + 'GroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AgreementType' => ['description' => 'Protocol Type.', 'type' => 'string', 'example' => 'DUBBO', 'title' => ''], + 'ServicePort' => ['description' => 'Service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '8848', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DynamicRoute' => ['description' => 'Whether to enable dynamic routing', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'TotalSize' => [ - 'title' => '总共有多少个节点。', - 'description' => 'The total number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '第几页，从1开始。', - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少个。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83F02EAB-ECDF-55C6-B332-8649E5E7AF2C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 36,\\n \\"PageNumber\\": 11,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 47,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-cf0e7f52ecc7429dbc7ba4d5e3656100\\",\\n \\"GatewayId\\": 496,\\n \\"Status\\": 2,\\n \\"RouteOrder\\": 1,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"DefaultServiceId\\": 1,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/rpc/compute \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":true}}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/getIp\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"GmtCreate\\": \\"2022-01-25T07:14:01.817+0000\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"Services\\": \\"[]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 1563,\\n \\"ServiceName\\": \\"hu\\",\\n \\"Percent\\": 11,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"test\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"api\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"HttpDubboTranscoder\\": {\\n \\"DubboServiceName\\": \\"org.apache.dubbo.samples.basic.api.DemoService\\",\\n \\"DubboServiceVersion\\": \\"0.0.0\\",\\n \\"MothedMapList\\": [\\n {\\n \\"DubboMothedName\\": \\"sayHello\\",\\n \\"HttpMothed\\": \\"ALL_GET\\",\\n \\"Mothedpath\\": \\"/mytestzbk/sayhello\\",\\n \\"PassThroughAllHeaders\\": \\"PASS_NOT\\",\\n \\"PassThroughList\\": [\\n \\"x-forward\\"\\n ],\\n \\"ParamMapsList\\": [\\n {\\n \\"ExtractKeySpec\\": \\"ALL_QUERY_PARAMETER\\",\\n \\"ExtractKey\\": \\"name\\",\\n \\"MappingType\\": \\"java.lang.String\\"\\n }\\n ]\\n }\\n ],\\n \\"DubboServiceGroup\\": \\"service group\\"\\n },\\n \\"ServicePort\\": 20880,\\n \\"HealthStatus\\": \\"Health\\",\\n \\"UnhealthyEndpoints\\": [\\n \\"192.168.1.2\\"\\n ]\\n }\\n ],\\n \\"DomainId\\": 265,\\n \\"DomainName\\": \\"y.com\\",\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"hello\\"\\n },\\n \\"DomainIdList\\": [\\n 123\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"test.com\\",\\n \\"Path\\": \\"/test\\"\\n },\\n \\"Type\\": \\"Op\\",\\n \\"Comment\\": {\\n \\"Status\\": \\"error\\"\\n },\\n \\"EnableWaf\\": \\"false\\",\\n \\"Fallback\\": true,\\n \\"FallbackServices\\": [\\n {\\n \\"ServiceId\\": 353,\\n \\"ServiceName\\": \\"service name\\",\\n \\"Percent\\": 100,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"name\\",\\n \\"SourceType\\": \\"MSE\\\\n\\",\\n \\"Namespace\\": \\"Namespace\\",\\n \\"GroupName\\": \\"test\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"ServicePort\\": 8848\\n }\\n ],\\n \\"DynamicRoute\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayRoute', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Ip\\": \\"10.1.2.3\\",\\n \\"Tags\\": [\\n {\\n \\"Tag\\": \\"gray\\"\\n }\\n ],\\n \\"Port\\": \\"8080\\"\\n }\\n ],\\n \\"TotalSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'GetApplicationInstanceList', ], - 'QueryGovernanceKubernetesCluster' => [ - 'summary' => 'Queries the Kubernetes clusters for which Microservices Governance is activated.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayRouteOnAuth' => [ + 'summary' => 'Queries a list of routes for which authentication is enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -32503,414 +22062,482 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '116299', - 'abilityTreeNodes' => [ - 'FEATUREmse3O985H', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'ClusterName', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => 'Kubernetes集群名', - 'description' => 'The name of the Kubernetes cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-cluster', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => 'Kubernetes集群Id', - 'description' => 'The ID of the Kubernetes cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'c24c9354acxxxxxxx', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '当前页码', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '每页元素数量', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '10', - ], + 'schema' => ['description' => 'The authentication method. Valid values:'."\n" + ."\n" + .'* JWT'."\n", 'type' => 'string', 'required' => true, 'example' => 'JWT', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DE34D413-2B79-5E77-9696-36D875E822AD', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The route ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Name' => ['description' => 'The name of the route.'."\n", 'type' => 'string', 'example' => 'ceshi', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'example' => '399', 'title' => ''], + 'RoutePredicates' => [ + 'description' => 'The information about route matching.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterName' => [ - 'title' => 'Kubernetes集群名', - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'example-cluster', - ], - 'ClusterId' => [ - 'title' => 'Kubernetes集群Id', - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'abcdef123456789', - ], - 'Region' => [ - 'title' => 'Kubernetes集群所在的地域', - 'description' => 'The region where the cluster resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'K8sVersion' => [ - 'title' => 'Kubernetes集群版本', - 'description' => 'The version of the cluster.'."\n", - 'type' => 'string', - 'example' => '1.22', - ], - 'NamespaceInfos' => [ - 'title' => 'Kubernetes集群命名空间信息（json格式）', - 'description' => 'The information about the namespace.'."\n", - 'type' => 'string', - 'example' => '[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]', - ], - 'PilotStartTime' => [ - 'title' => 'pilot启动时间', - 'description' => 'The time when the pilot component was started.'."\n", - 'type' => 'string', - 'example' => '2022-05-17T05:39:43.000+0000', - ], - 'VersionLifeCycle' => [ - 'type' => 'string', - ], - 'PilotVersion' => [ - 'type' => 'string', + 'PathPredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The path.'."\n", 'type' => 'string', 'example' => '/api', 'title' => ''], + 'Type' => ['description' => 'The matching type.'."\n", 'type' => 'string', 'example' => 'PRE', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'DomainId' => ['description' => 'The domain ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '235', 'title' => ''], + 'DomainName' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => '123.com', 'title' => ''], + 'DomainIdList' => [ + 'description' => 'The domain IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The domain ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DomainNameList' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'TotalSize' => [ - 'title' => '页码总数', - 'description' => 'The total number of clusters.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PageNumber' => [ - 'title' => '当前页码', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页大小', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 12,\\n \\"Name\\": \\"ceshi\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": \\"399\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/api\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"123.com\\",\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewayRouteOnAuth', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRouteOnAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DE34D413-2B79-5E77-9696-36D875E822AD\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"ClusterName\\": \\"example-cluster\\",\\n \\"ClusterId\\": \\"abcdef123456789\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"K8sVersion\\": \\"1.22\\",\\n \\"NamespaceInfos\\": \\"[{\\\\\\"Name\\\\\\":\\\\\\"ack-onepilot\\\\\\",\\\\\\"Tags\\\\\\":{\\\\\\"name\\\\\\":\\\\\\"ack-onepilot\\\\\\"}}]\\",\\n \\"PilotStartTime\\": \\"2022-05-17T05:39:43.000+0000\\",\\n \\"VersionLifeCycle\\": \\"\\",\\n \\"PilotVersion\\": \\"\\"\\n }\\n ],\\n \\"TotalSize\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'QueryGovernanceKubernetesCluster', ], - 'ModifyGovernanceKubernetesCluster' => [ - 'summary' => 'Modifies the information about a cluster for which Microservice Governance is enabled.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayService' => [ + 'summary' => 'Retrieves the list of services to which a gateway is subscribed.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '25610', - 'abilityTreeNodes' => [ - 'FEATUREmseSXV85E', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '25193', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd23228b3c80c4d4f9ad87cc3****', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'NamespaceInfos', - 'in' => 'formData', + 'name' => 'OrderItem', + 'in' => 'query', + 'schema' => ['description' => 'The sorting property.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreate', 'title' => ''], + ], + [ + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether to sort the results in descending order.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'FilterParams', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '命名空间接入MSE服务治理的对应信息。', - 'description' => 'The information about the namespace for which Microservices Engine(MSE) Microservices Governance is enabled.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'kubernetes命名空间名字。', - 'description' => 'The name of the Kubernetes namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'MseNamespace' => [ - 'title' => '对应的微服务命名空间，为空代表没有接入。', - 'description' => 'The microservice namespace. If you do not specify this parameter, Microservice Governance is not enabled for the namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'description' => 'The filter conditions, specified as a JSON string, such as {"key1":"value1"}.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'SourceType' => ['description' => 'The source type.', 'type' => 'string', 'required' => false, 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'public', 'title' => ''], + 'GroupName' => ['description' => 'The group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique gateway ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'ServiceProtocol' => [ + 'description' => 'The service protocol.'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'- HTTPS'."\n" + ."\n" + .'- HTTP2'."\n" + ."\n" + .'- GRPC'."\n" + ."\n" + .'- DUBBO', + 'enumValueTitles' => ['HTTP2' => 'HTTP2', 'HTTPS' => 'HTTPS', 'HTTP' => 'HTTP', 'DUBBO' => 'DUBBO', 'GRPC' => 'GRPC'], + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + 'title' => '', ], - 'required' => false, ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The response language. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F46CDBA4-B1EE-5C94-8A48-51C10177****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Specifies whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The deletion result.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Result' => [ + 'description' => 'The list of services.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a service.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SourceType' => ['description' => 'The source type.', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'GroupName' => ['description' => 'The group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SourceId' => ['description' => 'The source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ServiceNameInRegistry' => ['description' => 'The original service name in the service registry.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MetaInfo' => ['description' => 'The service metadata.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Ips' => [ + 'description' => 'A list of the service\'s IP addresses.', + 'type' => 'array', + 'items' => ['description' => 'An IP address of the service.', 'type' => 'string', 'example' => '127.0.2.1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'GmtCreate' => ['description' => 'The time when the service was created.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the service was last modified.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'Versions' => [ + 'description' => 'A list of service versions.', + 'type' => 'array', + 'items' => [ + 'description' => 'A service version.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ServiceProtocol' => ['description' => 'The service protocol.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'ServicePort' => ['description' => 'The service port.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'HealehStatus' => ['description' => 'The health status of the service. Valid values:'."\n" + ."\n" + .'- `Health`'."\n" + ."\n" + .'- `Unhealthy`'."\n" + ."\n" + .'- `Unknown`', 'type' => 'string', 'example' => 'Unhealthy', 'title' => ''], + 'HealthStatus' => ['description' => 'The health status of the service. Valid values:'."\n" + ."\n" + .'- `Health`'."\n" + ."\n" + .'- `Unhealthy`'."\n" + ."\n" + .'- `Unknown`', 'type' => 'string', 'example' => 'Unhealthy', 'title' => ''], + 'HealthCheck' => ['description' => 'Specifies whether to perform a health check.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HealthCheckInfo' => [ + 'description' => 'The health check configuration.', + 'type' => 'object', + 'properties' => [ + 'Check' => ['description' => 'Specifies whether to enable the health check.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Protocol' => ['description' => 'The protocol for the health check.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'Timeout' => ['description' => 'The timeout for the health check, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Interval' => ['description' => 'The interval between health checks, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'HealthyThreshold' => ['description' => 'The number of consecutive successful health checks required for an endpoint to be considered healthy.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'UnhealthyThreshold' => ['description' => 'The number of consecutive failed health checks required for an endpoint to be considered unhealthy.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'HttpPath' => ['description' => 'The HTTP path for the health check.', 'type' => 'string', 'example' => '/health', 'title' => ''], + 'HttpHost' => ['description' => 'The host for the health check HTTP request.', 'type' => 'string', 'example' => 'http://172.168.0.1', 'title' => ''], + 'ExpectedStatuses' => [ + 'description' => 'A list of expected HTTP status codes that indicate a successful health check.', + 'type' => 'array', + 'items' => ['description' => 'An expected HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'UnhealthyEndpoints' => [ + 'description' => 'A list of unhealthy endpoints.', + 'type' => 'array', + 'items' => ['description' => 'An unhealthy endpoint.', 'type' => 'string', 'example' => '172.168.0.1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'GatewayTrafficPolicy' => [ + 'description' => 'The traffic management policy.', + 'type' => 'object', + 'properties' => [ + 'Tls' => [ + 'description' => 'The Transport Layer Security (TLS) settings.', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => 'DISABLE, SIMPLE, MUTUAL, ISTIO_MUTUAL', 'description' => 'The TLS mode.'."\n" + ."\n" + .'- `DISABLE`'."\n" + ."\n" + .'- `SIMPLE`'."\n" + ."\n" + .'- `MUTUAL`'."\n" + ."\n" + .'- `ISTIO_MUTUAL`', 'type' => 'string', 'example' => 'SIMPLE'], + 'CertId' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => '5******-cn-hangzhou', 'title' => ''], + 'CaCertId' => ['description' => 'The ID of the CA certificate.', 'type' => 'string', 'example' => '5******-cn-hangzhou', 'title' => ''], + 'CaCertContent' => ['description' => 'The public key of the CA certificate.', 'type' => 'string', 'example' => 'content', 'title' => ''], + 'SubjectAltNames' => [ + 'description' => 'A list of subject alternative names (SANs).', + 'type' => 'array', + 'items' => ['description' => 'A subject alternative name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Sni' => ['description' => 'The Server Name Indication (SNI).', 'type' => 'string', 'example' => 'name-sni', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'LoadBalancerSettings' => [ + 'description' => 'The load balancing settings.', + 'type' => 'object', + 'properties' => [ + 'LoadbalancerType' => ['title' => 'ROUND_ROBIN, LEAST_CONN, RANDOM, CONSISTENT_HASH', 'description' => 'The load balancing policy.'."\n" + ."\n" + .'- `ROUND_ROBIN`'."\n" + ."\n" + .'- `LEAST_CONN`'."\n" + ."\n" + .'- `RANDOM`'."\n" + ."\n" + .'- `CONSISTENT_HASH`', 'type' => 'string', 'example' => 'RANDOM'], + 'ConsistentHashLBConfig' => [ + 'description' => 'Configuration for cookie-based consistent hashing.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The name of the parameter used for the consistent hash.', 'type' => 'string', 'example' => 'param', 'title' => ''], + 'HttpCookie' => [ + 'description' => 'Configuration for cookie-based consistent hashing.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the cookie.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Path' => ['description' => 'The path of the cookie.', 'type' => 'string', 'example' => '/path', 'title' => ''], + 'Ttl' => ['description' => 'The time to live (TTL) of the cookie.', 'type' => 'string', 'example' => '360', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'MinimumRingSize' => ['description' => 'The minimum size of the hash ring.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ConsistentHashLBType' => ['title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', 'description' => 'The consistent hash method.'."\n" + ."\n" + .'- `HEADER`'."\n" + ."\n" + .'- `COOKIE`'."\n" + ."\n" + .'- `SOURCE_IP`'."\n" + ."\n" + .'- `QUERY_PARAMETER`', 'type' => 'string', 'example' => 'HEADER'], + ], + 'title' => '', + 'example' => '', + ], + 'WarmupDuration' => ['description' => 'The warm-up duration in seconds. During this period, traffic to a newly added endpoint gradually increases.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Ports' => [ + 'description' => 'A list of service ports.', + 'type' => 'array', + 'items' => ['description' => 'A service port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ServiceFQDN' => ['description' => 'The fully qualified domain name (FQDN) of the service.', 'type' => 'string', 'title' => '', 'example' => ''], + 'DnsServerList' => [ + 'type' => 'array', + 'items' => ['description' => 'A DNS server address in the `IP address:Port` format.', 'type' => 'string', 'example' => '1.1.1.1:80', 'title' => ''], + 'description' => 'A list of DNS servers. This parameter is used only for DNS-based services.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F46CDBA4-B1EE-5C94-8A48-51C10177****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": 2,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.2.1\\"\\n ],\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"Versions\\": [\\n {\\n \\"Name\\": \\"v1\\"\\n }\\n ],\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServicePort\\": 80,\\n \\"HealehStatus\\": \\"Unhealthy\\",\\n \\"HealthStatus\\": \\"Unhealthy\\",\\n \\"HealthCheck\\": true,\\n \\"HealthCheckInfo\\": {\\n \\"Check\\": true,\\n \\"Protocol\\": \\"TCP\\",\\n \\"Timeout\\": 2,\\n \\"Interval\\": 2,\\n \\"HealthyThreshold\\": 2,\\n \\"UnhealthyThreshold\\": 2,\\n \\"HttpPath\\": \\"/health\\",\\n \\"HttpHost\\": \\"http://172.168.0.1\\",\\n \\"ExpectedStatuses\\": [\\n 200\\n ]\\n },\\n \\"UnhealthyEndpoints\\": [\\n \\"172.168.0.1\\"\\n ],\\n \\"GatewayTrafficPolicy\\": {\\n \\"Tls\\": {\\n \\"Mode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"5******-cn-hangzhou\\",\\n \\"CaCertId\\": \\"5******-cn-hangzhou\\",\\n \\"CaCertContent\\": \\"content\\",\\n \\"SubjectAltNames\\": [\\n \\"name\\"\\n ],\\n \\"Sni\\": \\"name-sni\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"param\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"name\\",\\n \\"Path\\": \\"/path\\",\\n \\"Ttl\\": \\"360\\"\\n },\\n \\"MinimumRingSize\\": 10000,\\n \\"ConsistentHashLBType\\": \\"HEADER\\"\\n },\\n \\"WarmupDuration\\": 10\\n }\\n },\\n \\"Ports\\": [\\n 8080\\n ],\\n \\"ServiceFQDN\\": \\"\\",\\n \\"DnsServerList\\": [\\n \\"1.1.1.1:80\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayService', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ModifyGovernanceKubernetesCluster', ], - 'GetGovernanceKubernetesCluster' => [ - 'summary' => 'Queries the information about a Container Service for Kubernetes (ACK) cluster for which Microservices Governance is enabled.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewaySlb' => [ + 'summary' => 'This operation queries gateway entry SLB instances.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -32918,506 +22545,237 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24691', - 'abilityTreeNodes' => [ - 'FEATUREmse3O985H', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EAB345F4-3AC3-560C-B653-65717703****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], + 'Code' => ['description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'ClusterId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc30d5', - ], - 'ClusterName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'myCluster', - ], - 'Region' => [ - 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'K8sVersion' => [ - 'description' => 'The version of Kubernetes.'."\n", - 'type' => 'string', - 'example' => '1.20.11-aliyun.1', - ], - 'NamespaceInfos' => [ - 'description' => 'The information of the namespace.'."\n", - 'type' => 'string', - 'example' => '[{\\"Name\\":\\"ack-onepilot\\",\\"Tags\\":null},{\\"Name\\":\\"default\\",\\"Tags\\":{\\"mse-enable\\":\\"enabled\\"}},{\\"Name\\":\\"kube-node-lease\\",\\"Tags\\":null},{\\"Name\\":\\"kube-public\\",\\"Tags\\":null},{\\"Name\\":\\"kube-system\\",\\"Tags\\":null}]', - ], - 'PilotStartTime' => [ - 'description' => 'The time when the pilot component was started.'."\n", - 'type' => 'string', - 'example' => '2022-01-11T11:50:38.000+0000', - ], - 'UpdateTime' => [ - 'description' => 'The time of the last modification.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T05:24:31.000+0000', - ], - 'Namespaces' => [ - 'description' => 'The queried namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'Kubernetes命名空间名字', - 'description' => 'The name of the namespace in the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'MseNamespace' => [ - 'title' => '对应接入的mse命名空间名字', - 'description' => 'The name of the MSE namespace that you want to access.'."\n", - 'type' => 'string', - 'example' => 'default', + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID of the record.', 'type' => 'string', 'example' => 'ID', 'title' => ''], + 'SlbId' => ['description' => 'The ID of the SLB instance.', 'type' => 'string', 'example' => 'lb-bp1kmnli3hdpreptw2ah3', 'title' => ''], + 'SlbIp' => ['description' => 'The IP address of the SLB instance.', 'type' => 'string', 'example' => '121.199.XX.XX', 'title' => ''], + 'SlbPort' => ['description' => 'The ports of the SLB instance.', 'type' => 'string', 'example' => '80,443', 'title' => ''], + 'Type' => ['description' => 'The network type. Valid values:'."\n" + ."\n" + .'- `PUB_NET`: public network'."\n" + ."\n" + .'- `PRIVATE_NET`: private network', 'type' => 'string', 'example' => 'PUB_NET', 'title' => ''], + 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time of the record.', 'type' => 'string', 'example' => '2022-01-14 14:39:16', 'title' => ''], + 'GatewaySlbMode' => ['description' => 'The source of the SLB association.', 'type' => 'string', 'example' => 'UserSelect', 'title' => ''], + 'GatewaySlbStatus' => ['description' => 'The association status of the SLB instance.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + 'StatusDesc' => ['description' => 'A detailed description of the status.', 'type' => 'string', 'example' => 'Associating', 'title' => ''], + 'VServerGroupId' => ['description' => 'The ID of the HTTP vServer group.', 'type' => 'string', 'example' => '353', 'title' => ''], + 'HttpPort' => ['description' => 'The HTTP port of the vServer group.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'HttpsPort' => ['description' => 'The HTTPS port of the vServer group.', 'type' => 'integer', 'format' => 'int32', 'example' => '443', 'title' => ''], + 'ServiceWeight' => ['description' => 'The service weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'EditEnable' => ['description' => 'Indicates whether the entry can be edited.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'HttpsVServerGroupId' => ['description' => 'The ID of the HTTPS vServer group.', 'type' => 'string', 'example' => '353', 'title' => ''], + 'VsMetaInfo' => ['description' => 'The metadata of the vServer groups.', 'type' => 'string', 'example' => '[{"protocol":"HTTP","vServerGroupName":"k8s/80/****","port":80,"vServerGroupId":"rsp-bp***"},{"protocol":"HTTPS","vServerGroupName":"k8s/443/***","port":443,"vServerGroupId":"rsp-bp*****"}]', 'title' => ''], + 'VServiceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Port' => ['description' => 'The listener port.', 'type' => 'string', 'example' => '443', 'title' => ''], + 'Protocol' => ['description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'- HTTPS'."\n" + ."\n" + .'- HTTP', 'type' => 'string', 'example' => 'HTTPS', 'title' => ''], + 'VServerGroupId' => ['description' => 'The ID of the vServer group.', 'type' => 'string', 'example' => 'rsp-bp183l2x70***', 'title' => ''], + 'VServerGroupName' => ['description' => 'The name of the vServer group.', 'type' => 'string', 'example' => 'k8s/31**0/***/istio-system/clusterid', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'Details of the SLB listeners.', + 'title' => '', + 'example' => '', ], + 'SlbType' => ['description' => 'The type of the SLB instance.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'PilotVersion' => [ - 'type' => 'string', - ], - 'VersionLifeCycle' => [ - 'type' => 'string', - ], + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAB345F4-3AC3-560C-B653-65717703****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Succ\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"ID\\",\\n \\"SlbId\\": \\"lb-bp1kmnli3hdpreptw2ah3\\",\\n \\"SlbIp\\": \\"121.199.XX.XX\\",\\n \\"SlbPort\\": \\"80,443\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"GatewayId\\": \\"1\\",\\n \\"GmtCreate\\": \\"2022-01-14 14:39:16\\",\\n \\"GatewaySlbMode\\": \\"UserSelect\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"Associating\\",\\n \\"VServerGroupId\\": \\"353\\",\\n \\"HttpPort\\": 80,\\n \\"HttpsPort\\": 443,\\n \\"ServiceWeight\\": 80,\\n \\"EditEnable\\": false,\\n \\"HttpsVServerGroupId\\": \\"353\\",\\n \\"VsMetaInfo\\": \\"[{\\\\\\"protocol\\\\\\":\\\\\\"HTTP\\\\\\",\\\\\\"vServerGroupName\\\\\\":\\\\\\"k8s/80/****\\\\\\",\\\\\\"port\\\\\\":80,\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-bp***\\\\\\"},{\\\\\\"protocol\\\\\\":\\\\\\"HTTPS\\\\\\",\\\\\\"vServerGroupName\\\\\\":\\\\\\"k8s/443/***\\\\\\",\\\\\\"port\\\\\\":443,\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-bp*****\\\\\\"}]\\",\\n \\"VServiceList\\": [\\n {\\n \\"Port\\": \\"443\\",\\n \\"Protocol\\": \\"HTTPS\\",\\n \\"VServerGroupId\\": \\"rsp-bp183l2x70***\\",\\n \\"VServerGroupName\\": \\"k8s/31**0/***/istio-system/clusterid\\"\\n }\\n ],\\n \\"SlbType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewaySlb', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Data\\": {\\n \\"ClusterId\\": \\"cd23228b3c80c4d4f9ad7af1d87cc30d5\\",\\n \\"ClusterName\\": \\"myCluster\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"K8sVersion\\": \\"1.20.11-aliyun.1\\",\\n \\"NamespaceInfos\\": \\"[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ack-onepilot\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"mse-enable\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\"}},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-node-lease\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-public\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-system\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null}]\\",\\n \\"PilotStartTime\\": \\"2022-01-11T11:50:38.000+0000\\",\\n \\"UpdateTime\\": \\"2022-01-12T05:24:31.000+0000\\",\\n \\"Namespaces\\": [\\n {\\n \\"Name\\": \\"default\\",\\n \\"MseNamespace\\": \\"default\\"\\n }\\n ],\\n \\"PilotVersion\\": \\"4.1.1\\",\\n \\"VersionLifeCycle\\": \\"STABLE\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetGovernanceKubernetesCluster', ], - 'ListNamespaces' => [ - 'summary' => 'Displays the list of namespaces, the number of online nodes in each namespace, and the total number of applications in each namespace. You can also call this operation to perform fuzzy queries based on the namespace name.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayZone' => [ + 'summary' => 'Queries the available zones for gateways.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '192223', - 'abilityTreeNodes' => [ - 'FEATUREmseSXV85E', - ], - 'tenantRelevance' => 'tenant', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174557', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '5', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myNamespace', - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - 'minItems' => 0, - ], - ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values: `zh` (Chinese) and `en` (English). Default value: `zh`.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', - ], + 'Code' => ['description' => 'The status code. A value of `200` is returned when `Success` is `true`.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'NO_PERMISSION', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'DynamicCode' => ['description' => 'The placeholder in the dynamic error message.', 'type' => 'string', 'example' => 'code', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic error message that is used to replace the **%s** placeholder in the ErrMessage parameter.', 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '178*******', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'myNamespace', - ], - 'Version' => [ - 'title' => '--- 基础版', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Describe' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'InstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'AppCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2024-09-02T09:49:48.000+0000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2024-09-02T09:49:48.000+0000', - ], - 'Tags' => [ - 'type' => 'object', - ], - ], - ], - ], - 'Results' => [ - 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '178*******', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'myNamespace', - ], - 'Version' => [ - 'title' => '--- 基础版', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Describe' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'InstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'AppCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2024-09-02T09:49:48.000+0000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2024-09-02T09:49:48.000+0000', - ], - ], - ], + 'description' => 'A list of zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure of a zone.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'LocalName' => ['description' => 'The name of the zone.', 'type' => 'string', 'example' => 'I', 'title' => ''], + 'SupportQat' => ['description' => 'Indicates whether the zone supports QAT.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"LocalName\\": \\"I\\",\\n \\"SupportQat\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewayZone', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1F1A6F3-7E03-5EAD-B3F1-123456789ABC\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 7,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"UserId\\": \\"178*******\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\",\\n \\"Version\\": 1,\\n \\"Describe\\": \\"测试命名空间1。\\",\\n \\"InstanceCount\\": 6,\\n \\"AppCount\\": 3,\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Tags\\": {\\n \\"1\\": \\"1\\",\\n \\"2\\": \\"2\\"\\n }\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"UserId\\": \\"178*******\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\",\\n \\"Version\\": 1,\\n \\"Describe\\": \\"测试命名空间1。\\",\\n \\"InstanceCount\\": 6,\\n \\"AppCount\\": 3,\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListNamespaces', ], - 'CreateNamespace' => [ - 'summary' => 'Creates a namespace for Microservices Governance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListInstanceCount' => [ + 'summary' => 'Displays the number of nodes that can be deployed for an instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33425,214 +22783,170 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '187065', - 'abilityTreeNodes' => [ - 'FEATUREmseSXV85E', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'title' => '要搜索的命名空间名字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myNamespace', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The type of the instance. Valid values: ZooKeeper and Nacos-Ans.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Nacos-Ans', 'title' => ''], ], [ - 'name' => 'Describe', + 'name' => 'MseVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The edition type of the instance. Valid values:'."\n" + ."\n" + .'* `mse_dev`: Developer Edition'."\n" + .'* `mse_pro`: Professional Edition'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_pro', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - 'minItems' => 0, - ], + 'schema' => ['description' => 'The ID of the region where the instance resides. Examples:'."\n" + ."\n" + .'* cn-hangzhou: China (Hangzhou)'."\n" + .'* cn-beijing: China (Beijing)'."\n" + .'* cn-shanghai: China (Shanghai)'."\n" + .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" + .'* cn-shenzhen: China (Shenzhen)'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '错误时的提示信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed. If the request failed, the ErrorCode parameter is returned. For more information, see the [Error codes](~~456441~~) section of this topic.'."\n", 'type' => 'string', 'example' => 'mse-100-100', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => '%s'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace `%s` in the `ErrMessage` parameter.'."\n" + ."\n" + .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '命名空间所属的地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'title' => '命名空间名字', - 'description' => '', - 'type' => 'string', - 'example' => 'myNamespace', - ], - ], + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The number of nodes that can be deployed for the instance of the current edition.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"%s\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n 3\\n ]\\n}","type":"json"}]', + 'title' => 'ListInstanceCount', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListInstanceCount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功。\\",\\n \\"RequestId\\": \\"D1F1A6F3-7E03-5EAD-B3F1-123456789ABC\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateNamespace', ], - 'DeleteNamespace' => [ - 'summary' => '删除MSE命名空间', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListIsolationRules' => [ + 'summary' => 'Query isolation rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163572', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '操作的地域', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'], ], [ - 'name' => 'Name', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '要删除的MSE命名空间名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'prod', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => ['description' => 'Find protection rules that contain the interface keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => 'Find protection rules for specified interface.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '/a'], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The first page. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. Default value: 6.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -33640,92 +22954,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '请求信息，错误排查用', - 'description' => '', - 'type' => 'string', + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'title' => '', + 'description' => 'The details of the rule.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '', + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => 'The name of the interface to which the rule applies. The interface name must be the same as the name on the interface details page in the console.', 'type' => 'string', 'title' => '', 'example' => '/a'], + 'Threshold' => ['description' => 'The concurrency threshold for isolation rules.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'RegionId' => ['description' => 'The region in which the cluster resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'FallbackObject' => ['description' => 'The behavior that was bound to the rule.', 'type' => 'string', 'title' => '', 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"'], + 'LimitApp' => ['description' => 'The source application of the request.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['description' => 'The first page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'TotalSize' => ['description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + ], 'example' => '', - 'default' => '请求处理成功', - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => 'abcde-efg', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'NO_PERMISSION', ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 3\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListIsolationRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"abcde-efg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\"\\n}","type":"json"}]', - 'title' => 'DeleteNamespace', ], - 'QueryNamespace' => [ - 'summary' => '查询MSE命名空间', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListListenersByConfig' => [ + 'summary' => 'Queries listeners based on configuration information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -33735,851 +23047,432 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'abilityTreeCode' => '17070', + 'abilityTreeNodes' => ['FEATUREmseHU6B10'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '操作的地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Parameter deprecated, no need to fill in', 'type' => 'string', 'required' => false, 'example' => '...', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-m7r1yurp00e', 'title' => ''], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zeekr-clueboss.yml', 'title' => ''], + ], + [ + 'name' => 'Group', 'in' => 'query', + 'schema' => ['description' => 'The group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The namespace ID. Default value: public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1', 'title' => ''], + ], + [ + 'name' => 'ExtGrayRules', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '要搜索的命名空间名字', - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GrayRuleType' => [ + 'type' => 'string', + 'enum' => ['Tags', 'Beta'], + 'description' => 'Canary rule type', + 'required' => false, + 'example' => 'Tags', + 'title' => '', + ], + 'GrayRuleName' => ['type' => 'string', 'description' => 'The canary version name.', 'required' => false, 'example' => 'test', 'title' => ''], + 'GrayRule' => ['type' => 'string', 'description' => 'The canary release rule. For a beta release, you can specify one or more client IP addresses for this parameter. You must separate multiple IP addresses with commas (,). For a tag-based canary release, the value is in the format of Tag name=Tag value. You must separate multiple tag values with commas (,).', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], + 'GrayRulePriority' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The canary version priority.', 'required' => false, 'example' => '100', 'title' => ''], + ], + 'description' => 'Canary rule item', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'Additional canary release rule list, when matching listeners, the additional canary release rules will be merged with existing rules for matching', 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh which indicates Chinese, and the value en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '错误时的提示信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'abcde-fg', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '返回的数据', - 'description' => 'The data returned.'."\n", + 'HttpCode' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'The count.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'Listeners' => [ + 'description' => 'The information about listeners.', 'type' => 'array', 'items' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'title' => '命名空间所属的地域', - 'description' => 'The region to which the namespace belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'title' => '命名空间名字', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'default', + 'Ip' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'Md5' => ['description' => 'The verification string.', 'type' => 'string', 'example' => '23sdfdf', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Labels' => [ + 'description' => 'The label of the listener.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The key-value pairs of the label.', 'example' => 'a=b', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Version' => ['description' => 'The current version of the listener. Valid values: gray and normal.', 'type' => 'string', 'example' => 'gray', 'title' => ''], + 'MatchRuleName' => ['type' => 'string', 'description' => 'The name of the canary rule that matches the current listener', 'example' => 'Matched canary rule name', 'title' => ''], + 'MatchRuleType' => ['type' => 'string', 'description' => 'The type of the matched canary rule', 'example' => 'Beta', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '75E1442F-11EC-567A-9CF0-5A36F7904F39', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"abcde-fg\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'QueryNamespace', - ], - 'ApplyTagPolicies' => [ - 'summary' => 'Modifies a tag-based routing rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'msc', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"Listeners\\": [\\n {\\n \\"Ip\\": \\"1.1.1.1\\",\\n \\"Md5\\": \\"23sdfdf\\",\\n \\"Status\\": \\"true\\",\\n \\"Labels\\": {\\n \\"key\\": \\"a=b\\"\\n },\\n \\"Version\\": \\"gray\\",\\n \\"MatchRuleName\\": \\"Matched canary rule name\\",\\n \\"MatchRuleType\\": \\"Beta\\"\\n }\\n ],\\n \\"RequestId\\": \\"75E1442F-11EC-567A-9CF0-5A36F7904F39\\",\\n \\"Message\\": \\"success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 2,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListListenersByConfig', + 'description' => '> The current OpenAPI is not the Nacos-SDK API. For information about the Nacos-SDK API, see [Official Documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListListenersByConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListListenersByIp' => [ + 'summary' => 'Queries the listener list based on an IP address.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '16993', - 'abilityTreeNodes' => [ - 'FEATUREmseW9QIF2', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17071', + 'abilityTreeNodes' => ['FEATUREmseHU6B10'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Extended request parameters in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间', - 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-i7m2cecji09', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'title' => '应用名字', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'Listener IP address.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '172.22.0.240', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => true, - 'docRequired' => true, - 'example' => 'h5pohqu3gd@xxx', - ], + 'schema' => ['description' => 'Namespace ID, default is public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ea02a522-9482-4255-bb65-dc0636d783f2', 'title' => ''], ], [ - 'name' => 'Rules', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'key为标签名。', - 'description' => 'The details of the routing rule.'."\n", + 'description' => 'Data structure.', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The routing rule does not take effect'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The routing rule takes effect'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 2'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' The routing rule is invalid'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n", - 'enumValueTitles' => [ - '', - '', - '', - ], - 'example' => '0', - ], - 'Rate' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'description' => 'The percentage.'."\n", - ], - 'Enable' => [ - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'description' => 'Specifies whether to enable the routing rule.'."\n", - ], - 'Tag' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The environment of the routing rule.'."\n", - 'example' => 'gray', - ], - 'Name' => [ - 'title' => '路由规则名称。', - 'description' => 'The name of the routing rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'description' => 'The ID of the routing rule.'."\n", - ], - 'InstanceNum' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The number of instances.'."\n", - 'example' => '10', - ], - 'Rules' => [ - 'title' => '规则信息。', - 'description' => 'The details of the routing rule.'."\n", + 'properties' => [ + 'HttpCode' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '202', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'Listeners' => [ + 'description' => 'Listener information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ - 'springcloud' => [ - 'title' => 'springcloud规则。', - 'description' => 'The rule of the Spring Cloud application.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'condition' => [ - 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'description' => 'The logical operation relationships. Valid values: AND and OR.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AND', - ], - 'restItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'datum' => [ - 'type' => 'string', - 'required' => false, - 'example' => '10', - 'description' => 'The value on which operators such as rawvalue are performed.'."\n", - ], - 'operator' => [ - 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'description' => 'The operator. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The name.'."\n", - 'example' => 'test1', - ], - 'required' => false, - 'description' => 'Information about the fields that are required by the list operator.'."\n", - ], - 'cond' => [ - 'title' => '比较符号，可取 >=, <=, >, <, == 。', - 'description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '==', - ], - 'divisor' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'description' => 'The divisor that is required by the mod operator.'."\n", - ], - 'remainder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The remainder.'."\n", - 'example' => '30', - ], - 'rate' => [ - 'title' => '比例规则，20% 的流量路由到该标签对应的节点。', - 'description' => 'The rate. A value of 20 indicates that 20% of the traffic is routed to the tagged node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'type' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'description' => 'The type.'."\n", - ], - 'name' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'key', - 'description' => 'The name.'."\n", - ], - 'value' => [ - 'type' => 'any', - 'required' => false, - 'example' => 'test', - 'description' => 'The value.'."\n", - ], - ], - 'required' => false, - ], - 'required' => false, - 'description' => '', - ], - 'triggerPolicy' => [ - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PERCENT' => '', - 'CONTENT' => '', - ], - 'example' => 'CONTENT', - 'description' => 'The policy type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PERCENT'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONTENT'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - ], - 'enable' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => 'Specifies whether to enable the routing rule.'."\n", - 'example' => 'true', - ], - 'appId' => [ - 'type' => 'string', - 'required' => false, - 'example' => '***@***', - 'description' => 'The ID of the application.'."\n", - ], - 'priority' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The priority.'."\n", - 'example' => '1', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - 'description' => 'The tag.'."\n", - ], - 'required' => false, - 'description' => 'The tags.'."\n", - ], - 'paths' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => '/hello', - 'description' => 'The path.'."\n", - ], - 'required' => false, - 'description' => 'The list of paths.'."\n", - ], - 'path' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The path.'."\n", - 'example' => '/hello', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'dubbo' => [ - 'title' => 'dubbo 规则。', - 'description' => 'The rules of the Dubbo application.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'appId' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The ID of the application.'."\n", - 'example' => '***@***'."\n", - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - 'description' => 'The tag.'."\n", - ], - 'required' => false, - 'description' => 'The tags.'."\n", - ], - 'triggerPolicy' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The policy type.'."\n", - 'example' => 'CONTENT', - ], - 'serviceName' => [ - 'title' => '服务名（接口）。', - 'description' => 'The service name (interface).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HelloService', - ], - 'group' => [ - 'title' => 'dubbo服务分组。', - 'description' => 'The group of the Dubbo application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'version' => [ - 'title' => 'dubbo服务版本。', - 'description' => 'The version of the Dubbo application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], - 'methodName' => [ - 'title' => 'dubbo服务的方法名。', - 'description' => 'The method name of the Dubbo application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], - 'paramTypes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'int', - 'description' => 'The data type of the parameter.'."\n", - ], - 'required' => false, - 'description' => 'The list of parameter data types.'."\n", - ], - 'condition' => [ - 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'description' => 'The logical operation relationships. Valid values: AND and OR.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AND', - ], - 'argumentItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'operator' => [ - 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'description' => 'The operator. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The name.'."\n", - 'example' => 'demo', - ], - 'required' => false, - 'description' => 'The list of names.'."\n", - ], - 'datum' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The value on which operators such as rawvalue are performed.'."\n", - 'example' => '30'."\n", - ], - 'cond' => [ - 'title' => '比较符号，可取 >=, <=, >, <, == 。', - 'description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '==', - ], - 'divisor' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The divisor that is required by the mod operator.'."\n", - 'example' => '30'."\n", - ], - 'remainder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30'."\n", - 'description' => 'The remainder.'."\n", - ], - 'rate' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The rate. A value of 20 indicates that 20% of the traffic is routed to the tagged node.'."\n", - 'example' => '10', - ], - 'index' => [ - 'title' => '参数位置，从0开始。', - 'description' => 'The position of the parameter, which starts from 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'expr' => [ - 'title' => '表达式，见其他字段解释。', - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'required' => false, - ], - 'value' => [ - 'title' => '比较的值。表达式得到的值会跟这个值比较。如果 operator 是 list 白名单，value 的值用 \\",\\" 分隔，比如 1,2,3。', - 'description' => 'The value that is used for comparison. The value obtained by the expression is compared with this value. If the list operator is used, data of the value parameter is separated by commas (,). For example, 1,2,3.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '1,2,3', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'description' => 'The list of parameter contents.'."\n", - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], + 'Md5' => ['description' => 'Verification string.', 'type' => 'string', 'example' => '23sdfdf', 'title' => ''], + 'DataId' => ['description' => 'Data ID.', 'type' => 'string', 'example' => 'test.yaml', 'title' => ''], + 'Group' => ['description' => 'Group.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'NamespaceId' => ['description' => 'Namespace ID', 'type' => 'string', 'example' => 'test', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****', 'title' => ''], + 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'Size of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'MSE-100-000', 'title' => ''], + 'Success' => ['description' => 'Request result, with the following values:'."\n" + ."\n" + .'- `true`: The request is successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => '{ "blue": { # Tag key. "rate": 20, # Rate. A value of 20 indicates that 20% of the traffic is routed to the node identified by the tag. "name": "luoye-route-test", # Routing rule name. "carryData": false, # Specifies whether to enable pass-through. This parameter is applicable to end-to-end canary release. "rules": { # Rule information. "dubbo": \\[{ # Dubbo rule. The system also supports Spring Cloud and Istio rule. "serviceName": "com.taobao.hsf.common.DemoService", # Service name (operation name). "group": "", # Group name. "version": "", # Service version. "methodName": "sayHello", # Method name. "condition": "AND", # Logical operator used by the following items. Valid values: AND and OR. "argumentItems": \\[{ # Array of rule details. "index": 0, # Index field. "expr": "", # Expression. Its details is described below. "operator": "rawvalue", # The comparison mode. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist. "value": "jim", # Base value. The value obtained by the expression will be compared with this value. If operator is set to list, separate the items specified for this parameter with commas (,). Example: 1,2,3. "cond": "==" # Comparison operator. Valid values: >=, <=, >, <, and ==. }] }] } }, "\\_base": { # Another tag key. "rate": 80 # Rate. A value of 20 indicates that 20% of the traffic is routed to the node identified by the tag. } }'."\n", + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Optional. The ID of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12233****', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 6,\\n \\"Listeners\\": [\\n {\\n \\"Md5\\": \\"23sdfdf\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"default\\",\\n \\"NamespaceId\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"MSE-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListListenersByIp', + 'description' => '> The current OpenAPI is not a Nacos-SDK API. For more information about the Nacos-SDK API, see [Official Documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListListenersByIp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], ], ], + ], + ], + 'ListMigrationTask' => [ + 'summary' => 'This operation queries cloud migration tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'Enable', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '155119', + 'abilityTreeNodes' => ['FEATUREmseKDDXNL'], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the routing rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The extended request parameters. This parameter is a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'OriginInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'whdc', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The data array.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the data.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'InstanceNum' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Remove' => [ - 'description' => 'Indicates whether the routing rule was deleted.'."\n", - 'type' => 'boolean', - ], - 'CarryData' => [ - 'description' => 'Indicates whether the field is the primary key.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tag' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'gray', - ], - 'Name' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Rules' => [ - 'description' => 'The details of the routing rule.'."\n", - 'type' => 'string', - 'example' => '{\\"_base\\": {\\"rate\\": 100, \\"remove\\": true}, \\"blue\\": {\\"rate\\": 0}}', - ], - 'Id' => [ - 'description' => 'The ID of the primary key.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Rate' => [ - 'description' => 'The rate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Enable' => [ - 'description' => 'Indicates whether the rule is enabled. Valid values:'."\n" - ."\n" - .'* `true`: The rule is enabled.'."\n" - .'* `false`: The rule is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Id' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the cluster. Valid values:'."\n" + ."\n" + .'- Nacos-Ans'."\n" + ."\n" + .'- ZooKeeper'."\n" + ."\n" + .'- Eureka', 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], + 'OriginInstanceAddress' => ['description' => 'The endpoint of the source instance.', 'type' => 'string', 'example' => '192.168.1.1:8848', 'title' => ''], + 'OriginInstanceName' => ['description' => 'The name of the source instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'OriginInstanceNamespace' => ['description' => 'The list of namespaces. This parameter is optional when the source instance is a Nacos instance.', 'type' => 'string', 'example' => 'fsdfsdfdsf', 'title' => ''], + 'TargetInstanceId' => ['description' => 'The ID of the destination instance.', 'type' => 'string', 'example' => 'mse-cn-zv*****', 'title' => ''], + 'TargetClusterName' => ['description' => 'The name of the destination instance.', 'type' => 'string', 'example' => 'multiple-nacos', 'title' => ''], + 'TargetClusterUrl' => ['description' => 'The URL of the destination instance.', 'type' => 'string', 'example' => 'mse-f1******-nacos-ans.mse.aliyuncs.com:8848', 'title' => ''], + 'ProjectDesc' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the task was updated.', 'type' => 'string', 'example' => '2021-12-30T06:41:52.000+0000', 'title' => ''], + 'SyncType' => ['description' => 'The synchronization type.', 'type' => 'string', 'example' => 'Service', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '451EBE59-5F33-5B15-83C1-78593B9*****', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"UserId\\": \\"2\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.1.1:8848\\",\\n \\"OriginInstanceName\\": \\"test\\",\\n \\"OriginInstanceNamespace\\": \\"fsdfsdfdsf\\",\\n \\"TargetInstanceId\\": \\"mse-cn-zv*****\\",\\n \\"TargetClusterName\\": \\"multiple-nacos\\",\\n \\"TargetClusterUrl\\": \\"mse-f1******-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"test\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2021-12-30T06:41:52.000+0000\\",\\n \\"SyncType\\": \\"Service\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"451EBE59-5F33-5B15-83C1-78593B9*****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListMigrationTask', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"InstanceNum\\": 1,\\n \\"Remove\\": true,\\n \\"CarryData\\": true,\\n \\"Tag\\": \\"gray\\",\\n \\"Name\\": \\"test\\",\\n \\"Rules\\": \\"{\\\\\\\\\\\\\\"_base\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"rate\\\\\\\\\\\\\\": 100, \\\\\\\\\\\\\\"remove\\\\\\\\\\\\\\": true}, \\\\\\\\\\\\\\"blue\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"rate\\\\\\\\\\\\\\": 0}}\\",\\n \\"Id\\": 12,\\n \\"Rate\\": 10,\\n \\"Enable\\": true\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ApplyTagPolicies', + 'translator' => 'manual', ], - 'ListApplicationsWithTagRules' => [ - 'summary' => 'Queries the routing rules of an application.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNacosConfigs' => [ + 'summary' => 'Queries Nacos configurations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -34589,518 +23482,153 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '17072', + 'abilityTreeNodes' => ['FEATUREmse8153EN'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The extended request parameters. The JSON format is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"appGroup\\":\\"sm_zk_asi_na610\\",\\"appName\\":\\"sm-zk\\",\\"appStage\\":\\"PUBLISH\\",\\"appUnit\\":\\"center\\",\\"bucId\\":\\"193554\\",\\"bucName\\":\\"Alibaba Mobile Business Group-UC\\",\\"provider\\":\\"aliyun\\"}', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '50', - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '200', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-7mz2fj****', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The source of the routing rule. Default value: edasmsc.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'edasmsc', - ], + 'schema' => ['description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'xjpc0h9h4d@xxx', - ], + 'schema' => ['description' => 'The ID of the data.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'zeekr-*', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间', - 'description' => 'The MSE namespace to which the application belongs.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - 'default' => 'default', - ], + 'schema' => ['description' => 'The name of the group. Default value: `default`'."\n", 'type' => 'string', 'required' => false, 'example' => 'crm', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名字', - 'description' => 'The name of the application.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fpx-pds-pns', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => 'The tags.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'billing', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fad732a7-ff1a-4f21-8126-4edd4****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The response parameters.', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的MSE命名空间', - 'description' => 'The MSE namespace to which the application belongs.', - 'type' => 'string', - 'example' => 'default', - ], - 'AppName' => [ - 'title' => '应用名', - 'description' => 'The application name.', - 'type' => 'string', - 'example' => 'service-lottery-core', - ], - 'AppId' => [ - 'description' => 'The application ID.', - 'type' => 'string', - 'example' => 'daqijp6c31@xxx', - ], - 'RouteRules' => [ - 'description' => 'The queried rules.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the rule.', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rate' => [ - 'title' => '比例规则，20% 的流量路由到该标签对应的节点。', - 'description' => 'The rate.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Enable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tag' => [ - 'title' => '标签名。', - 'description' => 'The tag.', - 'type' => 'string', - 'example' => 'gray', - ], - 'Name' => [ - 'title' => '路由规则名称。', - 'description' => 'The rule name.', - 'type' => 'string', - 'example' => 'dubbo', - ], - 'Id' => [ - 'description' => 'The rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '653', - ], - 'InstanceNum' => [ - 'description' => 'The number of instances.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rules' => [ - 'description' => 'The details of the routing rule.', - 'type' => 'object', - 'properties' => [ - 'springcloud' => [ - 'title' => 'springcloud规则。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'condition' => [ - 'type' => 'string', - ], - 'restItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'datum' => [ - 'type' => 'string', - ], - 'operator' => [ - 'type' => 'string', - ], - 'nameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'cond' => [ - 'type' => 'string', - ], - 'divisor' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'remainder' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'rate' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'type' => [ - 'type' => 'string', - ], - 'name' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - ], - 'triggerPolicy' => [ - 'type' => 'string', - ], - 'enable' => [ - 'type' => 'boolean', - ], - 'appId' => [ - 'type' => 'string', - ], - 'priority' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'paths' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'path' => [ - 'type' => 'string', - ], - ], - ], - ], - 'dubbo' => [ - 'title' => 'dubbo 规则。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'appId' => [ - 'type' => 'string', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'triggerPolicy' => [ - 'type' => 'string', - ], - 'serviceName' => [ - 'title' => '服务名（接口）。', - 'description' => '', - 'type' => 'string', - ], - 'group' => [ - 'title' => 'dubbo服务分组。', - 'description' => '', - 'type' => 'string', - ], - 'version' => [ - 'title' => 'dubbo服务版本。', - 'description' => '', - 'type' => 'string', - ], - 'methodName' => [ - 'title' => 'dubbo服务方法名。', - 'description' => '', - 'type' => 'string', - ], - 'paramTypes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'condition' => [ - 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'description' => '', - 'type' => 'string', - ], - 'argumentItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'operator' => [ - 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'description' => '', - 'type' => 'string', - ], - 'nameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'datum' => [ - 'type' => 'string', - ], - 'cond' => [ - 'title' => '比较符号，可取 >=, <=, >, <, == 。', - 'description' => '', - 'type' => 'string', - ], - 'divisor' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'remainder' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'rate' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'index' => [ - 'title' => '参数位置，从0开始。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'expr' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - 'example' => '{'."\n" - .' "dubbo": [{'."\n" - .' "serviceName": "com.taobao.hsf.common.DemoService",'."\n" - .' "group": "",'."\n" - .' "version": "",'."\n" - .' "methodName": "sayHello",'."\n" - .' "condition": "AND",'."\n" - .' "argumentItems": [{'."\n" - .' "index": 0,'."\n" - .' "expr": "",'."\n" - .' "operator": "rawvalue",'."\n" - .' "value": "jim",'."\n" - .' "cond": "=="'."\n" - .' }]'."\n" - .' }]'."\n" - .' }', - ], - ], - ], - ], - 'RouteStatus' => [ - 'description' => 'The route state. Valid values:'."\n" - ."\n" - .'* 0: disabled'."\n" - .'* 1: enabled', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'TotalSize' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4081087F-3429-5873-A1E7-D4B5479D0B84', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Configurations' => [ + 'description' => 'The configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DataId' => ['description' => 'The ID of the configuration.'."\n", 'type' => 'string', 'example' => 'log.yaml', 'title' => ''], + 'Id' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => '132****', 'title' => ''], + 'Group' => ['description' => 'The ID of the group.'."\n", 'type' => 'string', 'example' => 'public', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'OperationNotSupport', 'errorMessage' => 'The current cluster does not support this operation, %s.', 'description' => 'The current cluster does not support this operation, %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"4081087F-3429-5873-A1E7-D4B5479D0B84\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Configurations\\": [\\n {\\n \\"AppName\\": \\"test\\",\\n \\"DataId\\": \\"log.yaml\\",\\n \\"Id\\": \\"132****\\",\\n \\"Group\\": \\"public\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListNacosConfigs', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"service-lottery-core\\",\\n \\"AppId\\": \\"daqijp6c31@xxx\\",\\n \\"RouteRules\\": [\\n {\\n \\"Status\\": 1,\\n \\"Rate\\": 10,\\n \\"Enable\\": true,\\n \\"Tag\\": \\"gray\\",\\n \\"Name\\": \\"dubbo\\",\\n \\"Id\\": 653,\\n \\"InstanceNum\\": 1,\\n \\"Rules\\": {\\n \\"springcloud\\": [\\n {\\n \\"condition\\": \\"\\",\\n \\"restItems\\": [\\n {\\n \\"datum\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"nameList\\": [\\n \\"\\"\\n ],\\n \\"cond\\": \\"\\",\\n \\"divisor\\": 0,\\n \\"remainder\\": 0,\\n \\"rate\\": 0,\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"triggerPolicy\\": \\"\\",\\n \\"enable\\": true,\\n \\"appId\\": \\"\\",\\n \\"priority\\": 0,\\n \\"tags\\": [\\n \\"\\"\\n ],\\n \\"paths\\": [\\n \\"\\"\\n ],\\n \\"path\\": \\"\\"\\n }\\n ],\\n \\"dubbo\\": [\\n {\\n \\"appId\\": \\"\\",\\n \\"tags\\": [\\n \\"\\"\\n ],\\n \\"triggerPolicy\\": \\"\\",\\n \\"serviceName\\": \\"\\",\\n \\"group\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"methodName\\": \\"\\",\\n \\"paramTypes\\": [\\n \\"\\"\\n ],\\n \\"condition\\": \\"\\",\\n \\"argumentItems\\": [\\n {\\n \\"operator\\": \\"\\",\\n \\"nameList\\": [\\n \\"\\"\\n ],\\n \\"datum\\": \\"\\",\\n \\"cond\\": \\"\\",\\n \\"divisor\\": 0,\\n \\"remainder\\": 0,\\n \\"rate\\": 0,\\n \\"index\\": 0,\\n \\"expr\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RouteStatus\\": 1\\n }\\n ],\\n \\"TotalSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'ListApplicationsWithTagRules', ], - 'GetAppMessageQueueRoute' => [ - 'summary' => 'Queries information about canary release for messaging of an application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNacosHistoryConfigs' => [ + 'summary' => 'Queries the configuration history of a Nacos instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -35110,216 +23638,143 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '116141', - 'abilityTreeNodes' => [ - 'FEATUREmse4ZR99T', - ], + 'abilityTreeCode' => '17073', + 'abilityTreeNodes' => ['FEATUREmseEUE1FY'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the instance resides. Examples:'."\n" - ."\n" - .'* `cn-hangzhou`: China (Hangzhou)'."\n" - .'* `cn-beijing`: China (Beijing)'."\n" - .'* `cn-shanghai`: China (Shanghai)'."\n" - .'* `cn-zhangjiakou`: China (Zhangjiakou)'."\n" - .'* `cn-shenzhen`: China (Shenzhen)'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The extended request parameter in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{\\"appGroup\\":\\"aliyun-phecda-service-staging\\",\\"appName\\":\\"aliyun-phecda-service\\",\\"appStage\\":\\"DAILY\\",\\"appUnit\\":\\"center\\",\\"bucId\\":\\"250858\\",\\"bucName\\":\\" Alibaba Cloud\\",\\"provider\\":\\"aliyun\\"}', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hkhon1po62@c3df23522baa898', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-2r42e3bk20n', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the cluster is located. MSE supports specific regions.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user-prod.yaml', 'title' => ''], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => 'The name of the configuration group.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'fc-dev-cluster-1', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The namespace ID. Default value: public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fc0f6e40-****-946b-45e3af313707', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4B00BCB0-105F-5A2A-B75B-641C8E9B18FC', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@54e1f42f37cd65a', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Enable' => [ - 'description' => 'Indicates whether the canary release for messaging feature is enabled.'."\n" - ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tags' => [ - 'description' => 'The tags used to ignore message consumption for nodes in untagged environments.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag used to ignore message consumption for nodes in untagged environments.'."\n", - 'type' => 'string', - 'example' => 'gray', - ], - ], - 'FilterSide' => [ - 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", - 'type' => 'string', - 'example' => 'Server', - 'default' => 'Server', - 'enum' => [ - 'Server', - 'Client', - ], - ], - 'GrayBaseTags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '53338ECA-F880-54D8-A9B3-5606355A1B89', 'title' => ''], + 'Message' => ['description' => 'The message that is returned for the request.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HistoryItems' => [ + 'description' => 'The configuration items.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The tags of the application.', 'type' => 'string', 'example' => 'gateway', 'title' => ''], + 'DataId' => ['description' => 'The ID of the data.', 'type' => 'string', 'example' => 'test.yaml', 'title' => ''], + 'Group' => ['description' => 'The name of the group.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'LastModifiedTime' => ['description' => 'The timestamp when the configuration was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1643440066000', 'title' => ''], + 'Id' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '23fdsf', 'title' => ''], + 'OpType' => ['description' => 'The format of the configuration file.', 'type' => 'string', 'example' => 'yaml', 'title' => ''], + 'SrcUser' => ['description' => 'The user who modified this version', 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false. The value true indicates that the request was successful. The value false indicates that the request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"53338ECA-F880-54D8-A9B3-5606355A1B89\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HistoryItems\\": [\\n {\\n \\"AppName\\": \\"gateway\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"default\\",\\n \\"LastModifiedTime\\": 1643440066000,\\n \\"Id\\": 0,\\n \\"OpType\\": \\"yaml\\",\\n \\"SrcUser\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListNacosHistoryConfigs', + 'description' => '> The current OpenAPI is not the Nacos-SDK API. For information about the Nacos-SDK API, see [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosHistoryConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4B00BCB0-105F-5A2A-B75B-641C8E9B18FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"hkhon1po62@54e1f42f37cd65a\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Enable\\": true,\\n \\"Tags\\": [\\n \\"gray\\"\\n ],\\n \\"FilterSide\\": \\"Server\\",\\n \\"GrayBaseTags\\": [\\n \\"\\"\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetAppMessageQueueRoute', ], - 'UpdateMessageQueueRoute' => [ - 'summary' => 'Updates the configuration of a canary release for messaging of an application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNamespaces' => [ + 'summary' => 'Displays the namespace list, showing the number of online nodes and total applications in each namespace. This interface also supports fuzzy queries based on namespace names.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -35328,369 +23783,249 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '116139', - 'abilityTreeNodes' => [ - 'FEATUREmse4ZR99T', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '192223', + 'abilityTreeNodes' => ['FEATUREmseSXV85E'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tag that is negligible for the untagged environment of the application.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag that is negligible for the untagged environment of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - 'required' => false, - 'docRequired' => true, - ], - ], [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the canary release for messaging feature is enabled for the application. Valid values:'."\n" - ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hkhon1po62@c3df23522baa898', - ], + 'schema' => ['description' => 'Region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FilterSide', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Server', - 'default' => 'Server', - 'enum' => [ - 'Server', - 'Client', - ], - ], + 'schema' => ['description' => 'Page number for paged query.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'Number of entries per page for paged queries. The default is 5. To return more data, increase this value.', 'type' => 'integer', 'format' => 'int32', 'default' => '5', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'Namespace name for fuzzy query. If not specified, all namespaces are queried by default.', 'type' => 'string', 'required' => false, 'example' => 'myNamespace', 'title' => ''], ], [ - 'name' => 'GrayBaseTags', + 'name' => 'Tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'Tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'description' => 'Tag list, containing a maximum of 20 subkeys.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'minItems' => 0, + 'description' => 'Alibaba Cloud tags.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Language for displaying results. Values: zh (default): Chinese, en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E3919C62-876A-5926-A0BC-18351A24FA35', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', 'title' => ''], 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + 'description' => 'Return results.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'Result page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalSize' => ['description' => 'Total number of query results.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '7'], + 'PageSize' => ['description' => 'Page size for the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'Result' => [ + 'description' => 'Return results.', + 'type' => 'array', + 'items' => [ + 'description' => 'Result set.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'User ID.', 'type' => 'string', 'example' => '178*******', 'title' => ''], + 'Region' => ['description' => 'Region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'myNamespace', 'title' => ''], + 'Version' => ['description' => 'Version. Basic Edition 0, Professional Edition 1, Enterprise Edition 2.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Describe' => ['description' => 'Namespace description.', 'type' => 'string', 'example' => 'namespace 1 for testing', 'title' => ''], + 'InstanceCount' => ['description' => 'Number of online nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'AppCount' => ['description' => 'Number of applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-02T09:49:48.000+0000', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-02T09:49:48.000+0000', 'title' => ''], + 'Tags' => ['description' => 'Alibaba Cloud tags.', 'type' => 'object', 'example' => '{"1":"1","2":"2"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Results' => [ + 'title' => '', + 'description' => 'Result set.', + 'type' => 'array', + 'items' => [ + 'description' => 'Result collection.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'User ID.', 'type' => 'string', 'example' => '178*******', 'title' => ''], + 'Region' => ['description' => 'Region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'myNamespace', 'title' => ''], + 'Version' => ['description' => 'Version. Basic Edition 0, Professional Edition 1, Enterprise Edition 2.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Describe' => ['description' => 'Namespace description.', 'type' => 'string', 'example' => 'namespace 1 for testing', 'title' => ''], + 'InstanceCount' => ['description' => 'Number of online nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'AppCount' => ['description' => 'Number of applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-02T09:49:48.000+0000', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-02T09:49:48.000+0000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1F1A6F3-7E03-5EAD-B3F1-123456789ABC\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 7,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"UserId\\": \\"178*******\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\",\\n \\"Version\\": 1,\\n \\"Describe\\": \\"namespace 1 for testing\\",\\n \\"InstanceCount\\": 6,\\n \\"AppCount\\": 3,\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Tags\\": {\\n \\"1\\": \\"1\\",\\n \\"2\\": \\"2\\"\\n }\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"UserId\\": \\"178*******\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\",\\n \\"Version\\": 1,\\n \\"Describe\\": \\"namespace 1 for testing\\",\\n \\"InstanceCount\\": 6,\\n \\"AppCount\\": 3,\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListNamespaces', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListNamespaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E3919C62-876A-5926-A0BC-18351A24FA35\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"True\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateMessageQueueRoute', ], - 'AddMockRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListNamingTrack' => [ + 'summary' => 'Obtains the trajectory data of a Nacos registry.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '137915', + 'abilityTreeNodes' => ['FEATUREmseN8I3PF'], + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent-auto-test-sc', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-tl32d*****', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'edasmsc', - ], + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'fpx-xms-baseinfo', 'title' => ''], ], [ - 'name' => 'ProviderAppId', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service provider application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dcqtkuhnc4@66e5235415****', - ], + 'schema' => ['description' => 'The group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'group', 'title' => ''], ], [ - 'name' => 'ProviderAppName', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the service provider application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'demo-cartservice', - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cd4d3703-e2a6-46b5-85c6-4447e4f****', 'title' => ''], ], [ - 'name' => 'ExtraJson', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{}', - ], + 'schema' => ['description' => 'The IP address of the client.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.183.232', 'title' => ''], ], [ - 'name' => 'ScMockItems', + 'name' => 'StartTs', 'in' => 'query', - 'schema' => [ - 'description' => 'The input parameters. The JSON format is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[]', - ], + 'schema' => ['description' => 'The start timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1660238450', 'title' => ''], ], [ - 'name' => 'DubboMockItems', + 'name' => 'EndTs', 'in' => 'query', - 'schema' => [ - 'description' => 'The items in the recycle bin.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[]', - ], + 'schema' => ['description' => 'The end timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1665299698', 'title' => ''], ], [ - 'name' => 'ConsumerAppIds', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the custom application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{\\"appName\\":\\"provide\\",\\"appId\\":\\"bst8l6o735@f6d8aaf6e56e67d\\"}]', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" - ."\n" - .'* `true`: enables the alert rule.'."\n" - .'* `false`: disables the alert rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MockType', + 'name' => 'Reverse', 'in' => 'query', - 'schema' => [ - 'description' => 'The response time (RT) threshold of slow calls. Valid values:'."\n" - ."\n" - .'* \\- 15: 15 ms'."\n" - .'* \\- 30: 30 ms'."\n" - .'* \\- 60: 60 ms'."\n" - .'* \\- 120: 120 ms'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" + ."\n" + .'* `true`: sorts the query results in reverse chronological order.'."\n" + .'* `false`: sorts the query results in chronological order.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -35699,168 +24034,86 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'NamespaceId' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'ScMockItemJson' => [ - 'description' => 'The HTTP mock rule.'."\n", - 'type' => 'string', - 'example' => '[{"oper":"return+json","Path":"/mock","Value":"{\\n \\"date\\": \\"2021-09-10T07:45:12.357+0000\\",\\n \\"name\\": \\"name\\",\\n \\"id\\": \\"1\\"\\n}","Method":"GET","Condition":"AND","Timeout":1,"ArgumentMockItems":[{"type":"param","name":"id","value":"1","cond":"==","operator":"rawvalue"},{"type":"param","name":"name","value":"aliyun","cond":"==","operator":"rawvalue"}]}]', - ], - 'ConsumerAppName' => [ - 'description' => 'The name of the consumer application.'."\n", - 'type' => 'string', - 'example' => 'demo-xxxx', - ], - 'ConsumerAppId' => [ - 'description' => 'The ID of the consumer application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@a000601b265xxxx', - ], - 'AccountId' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '178432728867xxxx', - ], - 'ExtraJson' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'Source' => [ - 'description' => 'The service source.'."\n", - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'ProviderAppId' => [ - 'description' => 'The ID of the service provider application.'."\n", - 'type' => 'string', - 'example' => 'hkhon1po62@a000601b265xxxx', - ], - 'ProviderAppName' => [ - 'description' => 'The name of the service provider application.'."\n", - 'type' => 'string', - 'example' => 'demo-xxxx', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', - ], - 'Id' => [ - 'description' => 'The ID of the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '275', - ], - 'Enable' => [ - 'description' => 'Indicates whether the mock rule is enabled.'."\n" - ."\n" - .'* `true`: enabled'."\n" - .'* `false`: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MockType' => [ - 'description' => 'The mock type. Valid values:'."\n" - ."\n" - .'* \\- `[unk]0[unk]`: desktop client'."\n" - .'* \\- `[unk]1[unk]`: mobile client'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Traces' => [ + 'description' => 'The data information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PushTime' => ['description' => 'The push time.'."\n", 'type' => 'string', 'example' => '2022-12-16 11:48:07', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'mse-197*****-167083******-reg-center-0-0', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client.'."\n", 'type' => 'string', 'example' => '120.40.32.235', 'title' => ''], + 'ServerName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'fpx-xms-baseinfo', 'title' => ''], + 'Group' => ['description' => 'The group.'."\n", 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'InstanceSize' => ['description' => 'The number of instances.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PushTimeAll' => ['description' => 'The total push time.'."\n", 'type' => 'string', 'example' => '628ms', 'title' => ''], + 'PushTimeNetwork' => ['description' => 'The push time for the network.'."\n", 'type' => 'string', 'example' => '37ms', 'title' => ''], + 'SlaTime' => ['description' => 'The duration that is specified in the service-level agreement (SLA).'."\n", 'type' => 'string', 'example' => '628ms', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9916CBED-B2D5-5685-9129-4592FE1*****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 202 => [ + ['errorCode' => 'TrackRegionNotSupport', 'errorMessage' => '推送轨迹功能在当前Region暂未开放', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"PushTime\\": \\"2022-12-16 11:48:07\\",\\n \\"NodeName\\": \\"mse-197*****-167083******-reg-center-0-0\\",\\n \\"ClientIp\\": \\"120.40.32.235\\",\\n \\"ServerName\\": \\"fpx-xms-baseinfo\\",\\n \\"Group\\": \\"prod\\",\\n \\"InstanceSize\\": \\"1\\",\\n \\"PushTimeAll\\": \\"628ms\\",\\n \\"PushTimeNetwork\\": \\"37ms\\",\\n \\"SlaTime\\": \\"628ms\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"9916CBED-B2D5-5685-9129-4592FE1*****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListNamingTrack', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNamingTrack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": {\\n \\"NamespaceId\\": \\"cn-shanghai\\",\\n \\"ScMockItemJson\\": \\"[{\\\\\\"oper\\\\\\":\\\\\\"return+json\\\\\\",\\\\\\"Path\\\\\\":\\\\\\"/mock\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"{\\\\\\\\n \\\\\\\\\\\\\\"date\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"2021-09-10T07:45:12.357+0000\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"\\\\\\\\n}\\\\\\",\\\\\\"Method\\\\\\":\\\\\\"GET\\\\\\",\\\\\\"Condition\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"Timeout\\\\\\":1,\\\\\\"ArgumentMockItems\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"param\\\\\\",\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\",\\\\\\"cond\\\\\\":\\\\\\"==\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"rawvalue\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"param\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name\\\\\\",\\\\\\"value\\\\\\":\\\\\\"aliyun\\\\\\",\\\\\\"cond\\\\\\":\\\\\\"==\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"rawvalue\\\\\\"}]}]\\",\\n \\"ConsumerAppName\\": \\"demo-xxxx\\",\\n \\"ConsumerAppId\\": \\"hkhon1po62@a000601b265xxxx\\",\\n \\"AccountId\\": \\"178432728867xxxx\\",\\n \\"ExtraJson\\": \\"desc\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"ProviderAppId\\": \\"hkhon1po62@a000601b265xxxx\\",\\n \\"ProviderAppName\\": \\"demo-xxxx\\",\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\",\\n \\"Id\\": 275,\\n \\"Enable\\": true,\\n \\"MockType\\": 0\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AddMockRule', - 'summary' => 'Creates a service mocking rule.', ], - 'GetPlugins' => [ - 'summary' => 'Obtains plug-ins.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSSLCert' => [ + 'summary' => 'Retrieves a list of gateway certificates.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -35868,303 +24121,318 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '128636', - 'abilityTreeNodes' => [ - 'FEATUREmse7RUWJD', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'CertName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the plug-in. Valid values:'."\n" - ."\n" - .'* 0: custom'."\n" - .'* 1: permission authorization'."\n" - .'* 2: security protection'."\n" - .'* 3: transmission protocol'."\n" - .'* 4: traffic control'."\n" - .'* 5: traffic observation'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The certificate name that is used for fuzzy search.', 'type' => 'string', 'example' => 'certabc', 'title' => '', 'required' => false], ], [ - 'name' => 'EnableOnly', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable the plug-in.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => 'Schema of Response', + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CAA9A229-141D-5FBA-AC5C-516C02026A11'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'CertIdentifier' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'CertName' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'CommonName' => ['description' => 'The domain name with which the certificate is associated.', 'type' => 'string', 'example' => '*.test.com', 'title' => ''], + 'Sans' => ['description' => 'The SSL certificate.', 'type' => 'string', 'example' => 'SSL', 'title' => ''], + 'BeforeDate' => ['description' => 'The time when the certificate took effect. The time was formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1694503184803', 'title' => ''], + 'AfterDate' => ['description' => 'The time when the certificate expired. The time was formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1726039184803', 'title' => ''], + 'Algorithm' => ['description' => 'The algorithm.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Issuer' => ['description' => 'The issuer.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GmtBefore' => ['description' => 'The time when the certificate took effect. The time was formatted as a GMT timestamp.', 'type' => 'string', 'example' => '2023-09-12T07:19:44.803+0000', 'title' => ''], + 'GmtAfter' => ['description' => 'The time when the certificate expired. The time was formatted as a GMT timestamp.', 'type' => 'string', 'example' => '2024-09-11T07:19:44.803+0000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key-auth', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAA9A229-141D-5FBA-AC5C-516C02026A11\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"CertIdentifier\\": \\"1234\\",\\n \\"CertName\\": \\"test.com\\",\\n \\"CommonName\\": \\"*.test.com\\",\\n \\"Sans\\": \\"SSL\\",\\n \\"BeforeDate\\": \\"1694503184803\\",\\n \\"AfterDate\\": \\"1726039184803\\",\\n \\"Algorithm\\": \\"test\\",\\n \\"Issuer\\": \\"test\\",\\n \\"GmtBefore\\": \\"2023-09-12T07:19:44.803+0000\\",\\n \\"GmtAfter\\": \\"2024-09-11T07:19:44.803+0000\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSSLCert', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListSSLCert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'ListSecurityGroup' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-e98e40675aaf49bda082137d158e1585'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'zh: Chinese en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'example' => 'sg-8vb8gsmrqyc35k645rk6'], + 'SecurityGroupName' => ['description' => 'The name of the security group.'."\n", 'type' => 'string', 'example' => 'sg2'], + 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-bp1b'], + 'SecurityGroupType' => ['description' => 'The type of the security group. Valid values:'."\n" + ."\n" + .'* normal: basic security group'."\n" + .'* enterprise: advanced security group For more information, see [Advanced security groups](~~120621~~).'."\n", 'type' => 'string', 'example' => 'enterprise'], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-8vb8gsmrqyc35k645rk6\\",\\n \\"SecurityGroupName\\": \\"sg2\\",\\n \\"VpcId\\": \\"vpc-bp1b\\",\\n \\"SecurityGroupType\\": \\"enterprise\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSecurityGroup', + 'summary' => 'Obtains the information about security groups.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSecurityGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], + ], + 'ListSecurityGroupRule' => [ + 'summary' => 'Queries the security group rules for a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'The data returned.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The returned code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => '500', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data entries returned.'."\n", + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the plug-in.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the plug-in.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PrimaryUser' => [ - 'description' => 'The ID of the creator.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Category' => [ - 'description' => 'The type of the plug-in. Valid values:'."\n" - ."\n" - .'0: custom'."\n" - ."\n" - .'1: permission authorization'."\n" - ."\n" - .'2: security protection'."\n" - ."\n" - .'3: transmission protocol'."\n" - ."\n" - .'4: traffic control'."\n" - ."\n" - .'5: traffic observation'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'key-auth', - ], - 'Version' => [ - 'description' => 'The version of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Summary' => [ - 'description' => 'The summary of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'This is a plug-in.'."\n", - ], - 'SummaryEn' => [ - 'type' => 'string', - ], - 'Phase' => [ - 'description' => 'The execution stage of the plug-in.'."\n" - ."\n" - .'* 0: default stage'."\n" - .'* 1: authorization stage'."\n" - .'* 2: authentication stage'."\n" - .'* 3: statistics stage'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Priority' => [ - 'description' => 'The execution priority of the plug-in. A larger value indicates a higher priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConfigCheck' => [ - 'description' => 'The information about the plug-in configuration used for checking.'."\n", - 'type' => 'string', - 'example' => '\\# The configuration includes the fields required for checking, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", - ], - 'WasmLang' => [ - 'description' => 'The WebAssembly language. Valid values:'."\n" - ."\n" - .'* 0: C++'."\n" - .'* 1: TinyGo'."\n" - .'* 2: Rust'."\n" - .'* 3: AssemblyScript'."\n" - .'* 4: Zig'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PublishState' => [ - 'description' => 'The publish status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WasmFile' => [ - 'description' => 'The URL of the Object Storage Service (OSS) bucket that stores the WebAssembly plug-in.'."\n", - 'type' => 'string', - 'example' => 'https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm', - ], - 'Status' => [ - 'description' => 'Indicates whether the plug-in is enabled.'."\n" - ."\n" - .'* 0: disabled'."\n" - .'* 1: enabled'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Mode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'NewVersionPublishingFlag' => [ + 'Id' => ['description' => 'The ID of the security group authorization record.', 'type' => 'string', 'example' => '21', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'example' => 'sg-bp1cg6qlyjepj0y6cf2c', 'title' => ''], + 'PortRange' => ['description' => 'The port range.', 'type' => 'string', 'example' => '8000/8000', 'title' => ''], + 'IpProtocol' => ['description' => 'The protocol type.', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'AuthCidrs' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'title' => '', + 'example' => '', ], + 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'integer', 'format' => 'int64', 'example' => '81', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-12a432a1f5da423997d8880bd32c304d', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the rule was created.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the rule was last modified.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'Description' => ['description' => 'The description of the rule.', 'type' => 'string', 'example' => 'Test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"21\\",\\n \\"SecurityGroupId\\": \\"sg-bp1cg6qlyjepj0y6cf2c\\",\\n \\"PortRange\\": \\"8000/8000\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"AuthCidrs\\": [\\n \\"\\"\\n ],\\n \\"GatewayId\\": 81,\\n \\"GatewayUniqueId\\": \\"gw-12a432a1f5da423997d8880bd32c304d\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"Description\\": \\"Test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSecurityGroupRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"message\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"Category\\": 0,\\n \\"Name\\": \\"key-auth\\",\\n \\"Version\\": \\"v1\\",\\n \\"Summary\\": \\"这是一个插件\\",\\n \\"SummaryEn\\": \\"\\",\\n \\"Phase\\": 1,\\n \\"Priority\\": 1,\\n \\"ConfigCheck\\": \\"# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \\\\\\"name\\\\\\"、\\\\\\"age\\\\\\"、“friends” 字段\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\\\n\\",\\n \\"WasmLang\\": 0,\\n \\"PublishState\\": 1,\\n \\"WasmFile\\": \\"https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm\\",\\n \\"Status\\": \\"1\\",\\n \\"Mode\\": 0,\\n \\"MaxVersion\\": \\"1.0.0\\",\\n \\"NewVersionPublishingFlag\\": false\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetPlugins', + 'translator' => 'manual', ], - 'GetPluginConfig' => [ - 'summary' => 'Obtains plug-in configurations.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ListSentinelBlockFallbackDefinitions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -36173,4686 +24441,3401 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '128638', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '163990', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClassificationSet', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", + 'title' => '', + 'description' => 'Behavior Classification Set.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Behavior classification.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [1 => 'web', 'rpc'], + 'example' => '1', + ], + 'required' => false, ], ], [ - 'name' => 'PluginId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway plug-in.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Microservices namespace.', 'type' => 'string', 'required' => true, 'example' => 'default'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'zh: Chinese en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => '500', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the plug-in.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PrimaryUser' => [ - 'description' => 'The ID of the creator.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Category' => [ - 'description' => 'The category of the plug-in. Valid values:'."\n" - ."\n" - .'0: user-defined'."\n" - ."\n" - .'1: permission authentication'."\n" - ."\n" - .'2: security protection'."\n" - ."\n" - .'3: transmission protocol'."\n" - ."\n" - .'4: traffic control'."\n" - ."\n" - .'5: traffic observation'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Version' => [ - 'description' => 'The version of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Summary' => [ - 'description' => 'The summary of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'This is a plug-in.'."\n", - ], - 'SummaryEn' => [ - 'type' => 'string', - ], - 'Readme' => [ - 'description' => 'The description of the README file.'."\n", - 'type' => 'string', - 'example' => 'read me', - ], - 'ReadmeEn' => [ - 'description' => 'The description of the README file that is edited in English.'."\n", - 'type' => 'string', - 'example' => 'read me', - ], - 'ConfigExample' => [ - 'title' => '插件配置样例', - 'type' => 'string', - ], - 'Phase' => [ - 'description' => 'The execution stage of the plug-in. Valid values:'."\n" - ."\n" - .'0: default stage'."\n" - ."\n" - .'1: authorization stage'."\n" - ."\n" - .'2: authentication stage'."\n" - ."\n" - .'3: statistics stage'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Priority' => [ - 'description' => 'The execution priority of the plug-in. A larger value indicates a higher priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConfigCheck' => [ - 'description' => 'The information about the plug-in configuration used for checking.'."\n", - 'type' => 'string', - 'example' => '\\# The configuration includes the fields required for checking, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", - ], - 'Mode' => [ - 'description' => 'The mode.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WasmLang' => [ - 'description' => 'The WebAssembly language. Valid values:'."\n" - ."\n" - .'0: C++'."\n" - ."\n" - .'1: TinyGo'."\n" - ."\n" - .'2: Rust'."\n" - ."\n" - .'3: AssemblyScript'."\n" - ."\n" - .'4: Zig'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ImageName' => [ - 'description' => 'The name of the image.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'PublishState' => [ - 'description' => 'The publish status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'Indicates whether the plug-in is enabled. Valid values:'."\n" - ."\n" - .'0: disabled'."\n" - ."\n" - .'1: enabled'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'GatewayConfigList' => [ - 'description' => 'The list of gateway plug-in configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data object.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the plug-in configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', - ], - 'PluginId' => [ - 'description' => 'The ID of the gateway plug-in.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Enable' => [ - 'description' => 'Indicates whether the plug-in is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Config' => [ - 'description' => 'The plug-in configuration.'."\n", - 'type' => 'string', - 'example' => '\\# Configure a check for the required fields of the plug-in, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", - ], - 'ConfigLevel' => [ - 'description' => 'The application scope of the plug-in. Valid values:'."\n" - ."\n" - .'0: global'."\n" - ."\n" - .'1: domain names'."\n" - ."\n" - .'2: routes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResourceList' => [ - 'title' => '域名/路由资源列表（根据ConfigLevel区分）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Name' => [ - 'title' => '资源名称（域名/路由名）', - 'type' => 'string', - 'example' => 'test-route', - ], - ], - ], - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '1667309705000', - ], - 'GmtModified' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', - 'example' => '1667309705000', - ], - ], - ], - 'title' => '网关插件配置规则列表。规则排列顺序为路由级规则、域名级规则、实例级规则', - ], - 'RouteConfigStartIndex' => [ - 'title' => '路由级规则在GatewayConfigList中的起始下标。若不存在路由级规则，值为-1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DomainConfigStartIndex' => [ - 'title' => '域名级规则在GatewayConfigList中的起始下标。若不存在域名级规则，值为-1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'GatewayConfigStartIndex' => [ - 'title' => '实例规则在GatewayConfigList中的下标。若不存在实例级规则，值为-1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'VersionJson' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Behavior Id', 'type' => 'string', 'example' => '12'], + 'Namespace' => ['title' => '', 'description' => 'The name of the Microservices namespace.', 'type' => 'string', 'example' => 'default'], + 'AppName' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Name' => ['title' => '', 'description' => 'The name of the behavior.', 'type' => 'string', 'example' => 'defaultFallback'], + 'ResourceClassification' => ['title' => '', 'description' => 'Behavior classification.', 'type' => 'string', 'example' => '1'], + 'FallbackBehavior' => ['title' => '', 'description' => 'Behavior detail.', 'type' => 'object', 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}'], + 'TargetMap' => ['title' => '', 'description' => 'Resource information bound to the behavior.', 'type' => 'object', 'example' => '{"/params/{hot}":[1]}'], ], ], ], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"12\\",\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Name\\": \\"defaultFallback\\",\\n \\"ResourceClassification\\": \\"1\\",\\n \\"FallbackBehavior\\": {\\n \\"webRespStatusCode\\": 429,\\n \\"webRespMessage\\": \\"test\\",\\n \\"webFallbackMode\\": 0,\\n \\"webRespContentType\\": 0\\n },\\n \\"TargetMap\\": {\\n \\"/params/{hot}\\": [\\n 1\\n ]\\n }\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListSentinelBlockFallbackDefinitions', + 'summary' => 'Obtains the custom behavior of traffic protection.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSentinelBlockFallbackDefinitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"message\\",\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"Type\\": 0,\\n \\"Category\\": 0,\\n \\"Name\\": \\"name\\",\\n \\"Version\\": \\"v1\\",\\n \\"Summary\\": \\"这是一个插件。\\",\\n \\"SummaryEn\\": \\"\\",\\n \\"Readme\\": \\"read me\\",\\n \\"ReadmeEn\\": \\"read me\\",\\n \\"ConfigExample\\": \\"\\",\\n \\"Phase\\": 0,\\n \\"Priority\\": 1,\\n \\"ConfigCheck\\": \\"# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \\\\\\"name\\\\\\"、\\\\\\"age\\\\\\"、“friends” 字段\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"Mode\\": 0,\\n \\"WasmLang\\": 0,\\n \\"ImageName\\": \\"name\\",\\n \\"PublishState\\": 1,\\n \\"Status\\": \\"1\\",\\n \\"GatewayConfigList\\": [\\n {\\n \\"Id\\": 1,\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-ubuwqygbq4783gqb2y3f87q****\\",\\n \\"PluginId\\": 1,\\n \\"Enable\\": true,\\n \\"Config\\": \\"# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \\\\\\"name\\\\\\"、\\\\\\"age\\\\\\"、“friends” 字段\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"ConfigLevel\\": 0,\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 0,\\n \\"Name\\": \\"test-route\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"1667309705000\\",\\n \\"GmtModified\\": \\"1667309705000\\"\\n }\\n ],\\n \\"RouteConfigStartIndex\\": 0,\\n \\"DomainConfigStartIndex\\": 5,\\n \\"GatewayConfigStartIndex\\": 7,\\n \\"VersionJson\\": \\"[{\\\\\\"id\\\\\\":1, \\\\\\"version\\\\\\": \\\\\\"1.0.0\\\\\\"}]\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetPluginConfig', ], - 'CreatePluginConfig' => [ - 'summary' => 'Creates a plug-in configuration.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ListServiceSource' => [ + 'summary' => 'Queries a list of associated sources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '219339', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '24908', + 'abilityTreeNodes' => ['FEATUREmse5GGXKF'], ], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', - ], - ], - [ - 'name' => 'PluginId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关插件ID', - 'description' => 'The gateway plug-in ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], - ], - [ - 'name' => 'ConfigLevel', - 'in' => 'query', - 'schema' => [ - 'title' => '插件应用范围。'."\n" - ."\n" - .'- 全局：0'."\n" - .'- 路由：1'."\n" - .'- 域名：2', - 'description' => 'The application scope of the plug-in. Valid values:'."\n" - ."\n" - .'* 0: global'."\n" - .'* 1: route'."\n" - .'* 2: domain name'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'title' => '插件配置。Wasm 插件配置内容是 YAML 格式，Lua 插件配置内容是 Lua 代码。', - 'description' => 'The plug-in configuration. The configuration content of the WebAssembly (Wasm) plug-in is in the YAML format. The configuration content of the Lua plug-in is Lua code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'status_code: 200'."\n" - .'headers:'."\n" - .'- Content-Type=application/json'."\n" - .'body: "{\\"rule\\": \\"global\\"}"', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启。', - 'description' => 'Indicates whether the plug-in is enabled.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-c51a15c7ee934a4fb945ccf35fe1****', 'title' => ''], ], [ - 'name' => 'ResourceIdList', + 'name' => 'Source', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', - 'description' => 'The domain IDs or route IDs. They are distinguished based on ConfigLevel.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'ID值', - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Specifies the type of the returned service source. If this parameter is not specified, service sources of all types are returned. Valid values:'."\n" + ."\n" + .'- K8s: Container Service for Kubernetes (ACK) instance.'."\n" + ."\n" + .'- MSE Nacos: MSE'."\n" + ."\n" + .'- MSE ZooKeeper: MSE\\_ZK'."\n" + ."\n" + .'- SAE: SAE'."\n" + ."\n" + .'- EDAS: EDAS', 'type' => 'string', 'required' => false, 'example' => 'MSE', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'PluginConfigID' => [ - 'title' => '插件配置ID', - 'description' => 'The plug-in configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B8C4B0D8-EBB9-5F20-8295-04224FBE5529'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Address' => ['description' => 'The ACK ID or MSE registry address.', 'type' => 'string', 'example' => '***', 'title' => ''], + 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'NACOS', 'title' => ''], + 'Source' => ['description' => 'The type of the service source.', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'BindingWithGateway' => ['description' => 'Indicates whether the service source is associated with the gateway.'."\n" + .'(The value 1 indicates that the association is complete)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the environment was created.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2022-01-07 18:07:57', 'title' => ''], + 'SourceUniqueId' => ['description' => 'The unique ID of the service source.', 'type' => 'string', 'example' => 'mse-cn-***', 'title' => ''], + 'IngressOptions' => [ + 'description' => 'The application routing Ingress support.', + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => ['description' => 'Enables or disables Ingress.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IngressClass' => ['description' => 'The Ingress Class.', 'type' => 'string', 'example' => 'com.test.xxx', 'title' => ''], + 'WatchNamespace' => ['description' => 'The namespace that you want to monitor.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'EnableStatus' => ['description' => 'Indicates whether to update IngressStatus.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-2u9uhd9283hd92hgd39g239dg2*****', 'title' => ''], + 'GroupList' => [ + 'description' => 'The array of service groups.', + 'type' => 'array', + 'items' => ['description' => 'The service group.', 'type' => 'string', 'example' => 'DEFAULT_GROUP', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PathList' => [ + 'description' => 'The array of root paths of service lists.', + 'type' => 'array', + 'items' => ['description' => 'The root path of the service list.', 'type' => 'string', 'example' => '/path', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Invalid' => ['description' => 'Indicates whether the source is valid', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"PluginConfigID\\": 10\\n}","type":"json"}]', - 'title' => 'CreatePluginConfig', - ], - 'UpdatePluginConfig' => [ - 'summary' => 'Updates plug-in configurations.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'gateway', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8C4B0D8-EBB9-5F20-8295-04224FBE5529\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Address\\": \\"***\\",\\n \\"Type\\": \\"NACOS\\",\\n \\"Source\\": \\"MSE\\",\\n \\"BindingWithGateway\\": 1,\\n \\"GatewayId\\": 1,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"SourceUniqueId\\": \\"mse-cn-***\\",\\n \\"IngressOptions\\": {\\n \\"EnableIngress\\": true,\\n \\"IngressClass\\": \\"com.test.xxx\\",\\n \\"WatchNamespace\\": \\"default\\",\\n \\"EnableStatus\\": true\\n },\\n \\"GatewayUniqueId\\": \\"gw-2u9uhd9283hd92hgd39g239dg2*****\\",\\n \\"GroupList\\": [\\n \\"DEFAULT_GROUP\\"\\n ],\\n \\"PathList\\": [\\n \\"/path\\"\\n ],\\n \\"Invalid\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListServiceSource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'ListTagResources' => [ + 'summary' => 'Queries tagged resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '128635', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plug-in configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'GatewayId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'deprecated' => true, - ], + 'schema' => ['title' => '', 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', - ], + 'schema' => ['title' => '', 'description' => 'The token used to start the next query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kywps2Ezza3n8HAAzCCqsi'], ], [ - 'name' => 'PluginId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway plug-in.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* CLUSTER: MSE instance'."\n" + .'* GATEWAY: cloud-native gateway'."\n", 'type' => 'string', 'required' => true, 'example' => 'CLUSTER'], ], [ - 'name' => 'Enable', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable the plug-in.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The plug-in configuration. Configurations of WebAssembly plug-ins are in the YAML format, and configurations of Lua plug-ins are in the Lua code.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of a resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2st29t16', 'title' => ''], 'required' => false, - 'example' => '\\# Configure a check for the required fields of the plug-in, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", - ], - ], - [ - 'name' => 'ConfigLevel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application scope of the plug-in.'."\n" - ."\n" - .'* 0: global'."\n" - .'* 1: route'."\n" - .'* 2: domain name'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', + 'maxItems' => 51, + 'example' => '', ], ], [ - 'name' => 'ResourceIdList', + 'name' => 'Tag', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'title' => '', + 'description' => 'The list of tags. A maximum number of 20 tags are supported.'."\n", 'type' => 'array', 'items' => [ - 'title' => 'ID值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', + 'description' => 'The key-value pair of a tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['title' => '', 'description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - [ - 'name' => 'GmtCreate', - 'in' => 'query', - 'schema' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1667309705000', - 'deprecated' => true, - ], - ], - [ - 'name' => 'GmtModified', - 'in' => 'query', - 'schema' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', 'required' => false, - 'example' => '1667309705000', - 'deprecated' => true, + 'maxItems' => 21, + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'zh: Chinese en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => '500', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'Data' => [ - 'description' => 'The ID of the plug-in configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'NextToken' => ['title' => '', 'description' => 'The token that is required for the next query. If the NextToken parameter is empty, no subsequent query is required.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '92ED7C9C-84A2-595F-87FE-354F84C0F739', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '', + 'description' => 'The list of resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a resource and its tags, including the resource ID, the resource type, and the keys and values of the tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['title' => '', 'description' => 'The ID of the resource.'."\n", 'type' => 'string', 'example' => 'mse-cn-7pp2st29t16'], + 'ResourceType' => ['title' => '', 'description' => 'The type of the resource.'."\n", 'type' => 'string', 'example' => 'cluster'], + 'TagValue' => ['title' => '', 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'prd'], + 'TagKey' => ['title' => '', 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'env'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T\\",\\n \\"RequestId\\": \\"92ED7C9C-84A2-595F-87FE-354F84C0F739\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"mse-cn-7pp2st29t16\\",\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"prd\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListTagResources', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListTagResources', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"code\\",\\n \\"Data\\": 1\\n}","type":"json"}]', - 'title' => 'UpdatePluginConfig', ], - 'DeletePluginConfig' => [ - 'summary' => 'Deletes a plug-in configuration.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ListWebFlowRules' => [ + 'summary' => 'Queries hot parameter protection rules for HTTP requests.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '217729', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '164286', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'default' => 'default', 'example' => 'default', 'title' => ''], ], [ - 'name' => 'PluginConfigId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '插件配置ID', - 'description' => 'The plug-in configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '200', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a', 'title' => ''], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => ['description' => 'The interface keyword that you can search from protection rules. This parameter is mutually exclusive with the Resource parameter.', 'type' => 'string', 'required' => false, 'example' => 'flow', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'b22qb1****@2f0586be4b1****', 'title' => ''], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => 'The interface to which the protection rule applies. This parameter is mutually exclusive with the ResourceSearchKey parameter.', 'type' => 'string', 'required' => false, 'example' => '/flow', 'title' => ''], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The first page to export. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\"\\n}","type":"json"}]', - 'title' => 'DeletePluginConfig', - ], - 'AddSSLCert' => [ - 'summary' => 'Associates a certificate with a domain name of a gateway. You can specify a certificate that is hosted in Alibaba Cloud Security.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '35701', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], - ], - 'parameters' => [ - [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'CertIdentifier', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '5213641-cn-hangzhou', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E1CC74F0-5BDE-5220-A031-5CA622D80723', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4AE73569-304C-5AA9-AE11-C1D99C7D1689', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the association is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'Rule information', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'StatIntervalMs' => ['description' => 'The length of the time window. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Resource' => ['description' => 'The name of the interface resource.', 'type' => 'string', 'example' => '/flow', 'title' => ''], + 'ResourceType' => ['description' => 'The resource type'."\n" + ."\n" + .'- 0: custom interface'."\n" + ."\n" + .'- 1: WEB'."\n" + ."\n" + .'- 2: RPC', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ControlBehavior' => ['description' => 'The flow control method. Valid values:'."\n" + ."\n" + .'- 0: fast failure'."\n" + ."\n" + .'- 2: wait in queue', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Burst' => ['description' => 'The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens for the token bucket algorithm.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MaxQueueingTimeMs' => ['description' => 'The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ResourceMode' => ['description' => 'The resource mode. Valid values:'."\n" + ."\n" + .'- 0: resource name mode', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Threshold' => ['description' => 'The threshold.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the rule is enabled or disabled.'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ParamItem' => ['description' => 'The parameter description item, which is a JSON string containing the following key-value pairs:'."\n" + ."\n" + .'- parseStrategy: the parameter property (0: client IP address. 1: remote host. 2: header. 3: URL parameter)'."\n" + ."\n" + .'- fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3'."\n" + ."\n" + .'- matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match)'."\n" + ."\n" + .'- pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched', 'type' => 'string', 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1XXXX@c3df23522bXXXXX', 'title' => ''], + 'MetricType' => ['description' => 'The threshold type. Valid values:'."\n" + ."\n" + .'- 1: number of requests', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'FallbackObject' => ['description' => 'The behavior that was bound to the rule.', 'type' => 'string', 'example' => '{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalSize' => ['description' => 'The total number of queried rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '36', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4AE73569-304C-5AA9-AE11-C1D99C7D1689\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"RuleId\\": \\"1\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ResourceType\\": 1,\\n \\"ControlBehavior\\": 0,\\n \\"Burst\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"ResourceMode\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\",\\n \\"AppId\\": \\"hkhon1XXXX@c3df23522bXXXXX\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 36\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListWebFlowRules', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1CC74F0-5BDE-5220-A031-5CA622D80723\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'AddSSLCert', ], - 'AddGatewayDomain' => [ - 'summary' => 'Associates a domain name with a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ListZkTrack' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '35639', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'abilityTreeCode' => '150858', + 'abilityTreeNodes' => ['FEATUREmseN84UZV'], ], 'parameters' => [ [ - 'name' => 'MustHttps', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable HTTPS.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The request parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'CertIdentifier', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6828169-cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mse-cn-0ju2yq****'], ], [ - 'name' => 'Name', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test.com', - ], + 'schema' => ['description' => 'The path.'."\n", 'type' => 'string', 'required' => false, 'example' => '/path'], ], [ - 'name' => 'Protocol', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the protocol. Valid values:'."\n" - ."\n" - .'* `HTTP`'."\n" - .'* `HTTPS`'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '0x301fdfbdbf00***'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'StartTs', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], + 'schema' => ['description' => 'The start timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1669618483'], ], [ - 'name' => 'Http2', + 'name' => 'EndTs', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable `HTTP/2`.'."\n" - ."\n" - .'* `open`: enables `HTTP/2`'."\n" - .'* `close`: disables `HTTP/2`'."\n" - .'* `globalConfig`: uses global configurations'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'close', - ], + 'schema' => ['description' => 'The end timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1669619383'], ], [ - 'name' => 'TlsMax', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.3', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], ], [ - 'name' => 'TlsMin', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum version of TLS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.0', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'TlsCipherSuitesConfigJSON', + 'name' => 'Reverse', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'TLS加密套件配置', - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'title' => '加密套件配置类型', - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'DEFAULT', - 'CUSTOM', - ], - ], - 'TlsCipherSuites' => [ - 'title' => '加密套件名称列表', - 'type' => 'array', - 'items' => [ - 'title' => '加密套件名称', - 'type' => 'string', - 'example' => 'AES256-SHA', - ], - ], - ], - ], + 'schema' => ['description' => 'Specifies whether to enable reverse ordering.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '16BA802F-B848-55DF-9F57-CD71B7272D1F', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'HttpCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200'], + 'Traces' => [ + 'description' => 'The track data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogDate' => ['description' => 'The logging time.'."\n", 'type' => 'string', 'example' => '2022-11-28 15:09:15,606'], + 'Timestamp' => ['description' => 'The timestamp. It is not available.'."\n", 'type' => 'string', 'example' => '1669619383000'], + 'SessionId' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'example' => '0x301fdfbdbf00***'], + 'Path' => ['description' => 'The path.'."\n", 'type' => 'string', 'example' => '/path'], + 'TraceType' => ['title' => '', 'description' => 'The type of the trajectory. Valid values:'."\n" + ."\n" + .'* Push'."\n" + .'* Pull'."\n" + .'* Notify'."\n", 'type' => 'string', 'example' => 'Push'], + 'OpType' => ['title' => '', 'description' => 'The type of the operation. For trajectory of the Push type:'."\n" + ."\n" + .'* Create'."\n" + .'* Update'."\n" + .'* Delete'."\n" + .'* SetAcl'."\n" + .'* Multi'."\n" + ."\n" + .'For trajectory of the Pull type:'."\n" + ."\n" + .'* GetData'."\n" + .'* GetChild'."\n" + .'* GetStat'."\n", 'type' => 'string', 'example' => 'Create'], + 'EventType' => ['title' => '', 'description' => 'The type of the event. For trajectory of the Notify type:'."\n" + ."\n" + .'* NodeCreated'."\n" + .'* NodeDeleted'."\n" + .'* NodeDataChanged'."\n" + .'* NodeChildrenChanged'."\n", 'type' => 'string', 'example' => 'NodeCreated'], + 'DataType' => ['title' => '', 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'* persist'."\n" + .'* ephemeral'."\n", 'type' => 'string', 'example' => 'persist'], + 'Watch' => ['title' => '', 'description' => 'Indicates whether the monitoring feature is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Acl' => ['description' => 'The access control list (ACL).'."\n", 'type' => 'string', 'example' => 'world:anyone:cdrwa'], + 'MultiSize' => ['description' => 'The transaction size.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Result' => ['description' => 'The returned result.'."\n", 'type' => 'string', 'example' => 'success'], + 'Ttl' => ['description' => 'The time to live (TTL).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Finished' => ['description' => 'Indicates whether the transaction ended.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'."\n"], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'ok'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"LogDate\\": \\"2022-11-28 15:09:15,606\\",\\n \\"Timestamp\\": \\"1669619383000\\",\\n \\"SessionId\\": \\"0x301fdfbdbf00***\\",\\n \\"Path\\": \\"/path\\",\\n \\"TraceType\\": \\"Push\\",\\n \\"OpType\\": \\"Create\\",\\n \\"EventType\\": \\"NodeCreated\\",\\n \\"DataType\\": \\"persist\\",\\n \\"Watch\\": true,\\n \\"Acl\\": \\"world:anyone:cdrwa\\",\\n \\"MultiSize\\": 3,\\n \\"Result\\": \\"success\\",\\n \\"Ttl\\": 0,\\n \\"Finished\\": true\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\\\n\\",\\n \\"Message\\": \\"ok\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListZkTrack', + 'summary' => 'Obtains the track data of a ZooKeeper instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZkTrack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16BA802F-B848-55DF-9F57-CD71B7272D1F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 100\\n}","type":"json"}]', - 'title' => 'AddGatewayDomain', ], - 'DeleteGatewayDomain' => [ - 'summary' => 'Deletes a domain name that is associated with a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ListZnodeChildren' => [ + 'summary' => 'Queries the child nodes of a ZooKeeper node.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '35642', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '17075', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '109', - ], + 'schema' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-90392d768a3847a7b804c505254d****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '39016EAC-6EDB-52FE-AE20-4B013DF236FF', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'CONTACTINFO', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '253', - ], - 'Protocol' => [ - 'description' => 'The protocol.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'MustHttps' => [ - 'description' => 'Indicates whether HTTP probing is allowed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'example' => '243', - ], - 'GmtCreate' => [ - 'description' => 'The time when the domain name was added.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'Path' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'example' => '/zookeeper', 'title' => ''], + 'Dir' => ['description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => 'The current ZooKeeper operation is invalid, please recheck and perform the operation.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => 'No permission to operate the current node.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => 'The current node already exists. Please check and try again.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => 'The currently operating node does not exist and may have been deleted.'], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper the operation times out, it may be because the current Znode data is too large, there are too many child nodes, the server takes too long to process the request, or the cluster is currently selecting a host and cannot process the request.'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****\\",\\n \\"Data\\": [\\n {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/zookeeper\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListZnodeChildren', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZnodeChildren', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39016EAC-6EDB-52FE-AE20-4B013DF236FF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 2,\\n \\"Name\\": \\"CONTACTINFO\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 253,\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"243\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteGatewayDomain', ], - 'UpdateSSLCert' => [ - 'summary' => 'Updates a certificate.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ListZooKeeperSaslUser' => [ + 'summary' => 'Lists all ZooKeeper SASL users.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '35702', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217284', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], ], 'parameters' => [ [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the domain name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '210', - ], - ], - [ - 'name' => 'CertIdentifier', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5951436-cn-hangzhou', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-2a99625886d54722be94d92e9a69****', - ], - ], - [ - 'name' => 'AcceptLanguage', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mse-cn-5bffa4e8630'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CA689BED-08F3-54C2-A206-A0924E2ACA0A', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6C075654-E42F-5F58-914F-E11DA70881B7', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the update is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The SASL username.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'Description' => ['description' => 'The SASL user description.', 'type' => 'string', 'title' => '', 'example' => '测试'], + 'Status' => [ + 'description' => 'The SASL user status.', + 'type' => 'string', + 'maxLength' => 64, + 'enum' => ['UserAddNeedReload', 'UserRemoveNeedReload', 'PasswordResetNeedReload', 'Loaded'], + 'title' => '', + 'example' => 'UserAddNeedReload', + ], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1631001140913', 'title' => ''], + ], + 'description' => 'The data structure.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListZooKeeperSaslUser', + 'changeSet' => [], + 'ramActions' => [ [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA689BED-08F3-54C2-A206-A0924E2ACA0A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateSSLCert', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C075654-E42F-5F58-914F-E11DA70881B7\\",\\n \\"Data\\": [\\n {\\n \\"UserName\\": \\"test\\",\\n \\"Description\\": \\"测试\\",\\n \\"Status\\": \\"UserAddNeedReload\\",\\n \\"CreateTime\\": \\"1631001140913\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateGatewayDomain' => [ - 'summary' => 'Modifies the information about the domain name associated with a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'ModifyGovernanceKubernetesCluster' => [ + 'summary' => 'Modifies the information about a cluster for which Microservice Governance is enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '35640', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'abilityTreeCode' => '25610', + 'abilityTreeNodes' => ['FEATUREmseSXV85E'], ], 'parameters' => [ [ - 'name' => 'Protocol', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the protocol. Valid values:'."\n" - ."\n" - .'* HTTPS'."\n" - .'* HTTP'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS', - ], + 'schema' => ['description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MustHttps', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to forcibly use HTTPS.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd23228b3c80c4d4f9ad87cc3****', 'title' => ''], ], [ - 'name' => 'CertIdentifier', - 'in' => 'query', + 'name' => 'NamespaceInfos', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6209108-cn-hangzhou', - ], - ], + 'title' => '', + 'description' => 'The information about the namespace for which Microservices Engine(MSE) Microservices Governance is enabled.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the Kubernetes namespace.', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'MseNamespace' => ['title' => '', 'description' => 'The microservice namespace. If you do not specify this parameter, Microservice Governance is not enabled for the namespace.', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], [ - 'name' => 'Id', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the domain name that you want to update.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '94', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1', 'title' => ''], + 'Data' => ['description' => 'The deletion result.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ModifyGovernanceKubernetesCluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ModifyGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyLosslessRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'Http2', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '115999', + 'abilityTreeNodes' => ['FEATUREmse9OTHB7'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable `HTTP/2`.'."\n" - ."\n" - .'* `open`: `HTTP/2` is enabled.'."\n" - .'* `close`: `HTTP/2` is disabled.'."\n" - .'* `globalConfig`: Global configurations are used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'close', - ], + 'schema' => ['title' => 'regionId', 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'TlsMax', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.3', - ], + 'schema' => ['title' => 'appName', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'wx-work-api'], ], [ - 'name' => 'TlsMin', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum version of TLS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.0', - ], + 'schema' => ['title' => 'namespace', 'description' => 'The microservice namespace to which the rule applies.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default'], ], [ - 'name' => 'TlsCipherSuitesConfigJSON', + 'name' => 'AppId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => 'appName', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c644n5frmc@3e75f25fd4*****'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['title' => 'the switch of rule, TRUE means open, FALSE means close', 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" + ."\n" + .'* `true`: enables the rule.'."\n" + .'* `false`: disables the rule.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false'], + ], + [ + 'name' => 'WarmupTime', + 'in' => 'query', + 'schema' => ['title' => 'warmup time of App', 'description' => 'The prefetching duration.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '60'], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => ['title' => 'delay time of register to registry', 'description' => 'The registration latency.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'FuncType', + 'in' => 'query', + 'schema' => ['title' => 'warmup function type, 2 means f(x)=x^2', 'description' => 'The slope of the prefetching curve.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Aligned', + 'in' => 'query', + 'schema' => ['title' => 'microservices lifecycle aligns to k8s\'s or NOT', 'description' => 'Specifies whether to align the lifecycle of the application in the Kubernetes cluster with that of the microservice.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + [ + 'name' => 'Related', + 'in' => 'query', + 'schema' => ['title' => 'K8s\'s HPA is related to warmup or NOT', 'description' => 'Specifies whether to associate with service prefetching.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + [ + 'name' => 'LossLessDetail', + 'in' => 'query', + 'schema' => ['title' => 'show lossLess offline&online detail', 'description' => 'Specifies whether to display online and offline processing details.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Notice', + 'in' => 'query', + 'schema' => ['title' => 'enable lossLess offline active notification', 'description' => 'Specifies whether to enable notification.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'ConfigType' => [ - 'type' => 'string', - ], - 'TlsCipherSuites' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', 'title' => 'Id of the request'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'modifyLosslessRule success'], + 'Data' => ['description' => '返回数据。', 'type' => 'any', 'example' => 'null'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"modifyLosslessRule success\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'ModifyLosslessRule', + 'summary' => 'Modifies configurations of the lossless online and offline feature.', + 'changeSet' => [ + ['createdAt' => '2023-04-11T11:45:42.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-09T15:23:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-16T02:53:49.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ModifyLosslessRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'OfflineGatewayRoute' => [ + 'summary' => 'Disables a route for a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the route.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '645', 'title' => ''], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8EB24742-AB15-5953-BEFB-1FA18E770EEE'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the route is unpublished.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8EB24742-AB15-5953-BEFB-1FA18E770EEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'OfflineGatewayRoute', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:OfflineGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 403,\\n \\"Success\\": true,\\n \\"Data\\": 94\\n}","type":"json"}]', - 'title' => 'UpdateGatewayDomain', ], - 'ListSSLCert' => [ - 'summary' => 'Obtains a list of gateway certificates.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'OrderClusterHealthCheckRiskNotice' => [ + 'summary' => 'Subscribes to the notification feature if a risk is detected during a health check.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '150983', + 'abilityTreeNodes' => ['FEATUREmseZDUZ1K'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****', 'title' => ''], ], [ - 'name' => 'CertName', + 'name' => 'RiskCode', 'in' => 'query', - 'schema' => [ - 'title' => '按证书名称模糊搜索', - 'type' => 'string', - 'example' => 'certabc', - ], + 'schema' => ['description' => 'The ID of the risk item.'."\n", 'type' => 'string', 'required' => false, 'example' => '30010010001', 'title' => ''], + ], + [ + 'name' => 'Mute', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to disable the notification feature if the risk item occurs.'."\n" + ."\n" + .'* true: disabled'."\n" + .'* false: enabled'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'NoticeType', + 'in' => 'query', + 'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region in which the cluster resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CAA9A229-141D-5FBA-AC5C-516C02026A11', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'CertIdentifier' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'CertName' => [ - 'description' => 'The name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - 'CommonName' => [ - 'description' => 'The domain name with which the certificate is associated.'."\n", - 'type' => 'string', - 'example' => '*.test.com', - ], - 'Sans' => [ - 'description' => 'The SSL certificate.'."\n", - 'type' => 'string', - 'example' => 'SSL', - ], - 'BeforeDate' => [ - 'description' => 'The time when the certificate took effect. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'example' => '2031-03-30 02:35:12', - ], - 'AfterDate' => [ - 'description' => 'The time when the certificate expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'example' => ' 2021-04-01 02:35:12', - ], - 'Algorithm' => [ - 'description' => 'The algorithm.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Issuer' => [ - 'description' => 'The issuer of the certificate.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GmtBefore' => [ - 'description' => 'The time when the certificate took effect. This value is a GMT timestamp.'."\n", - 'type' => 'string', - 'example' => '2031-03-30 02:35:12', - ], - 'GmtAfter' => [ - 'description' => 'The time when the certificate expires. This value is a GMT timestamp.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 02:35:12', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the subscription was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'OrderClusterHealthCheckRiskNotice', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:OrderClusterHealthCheckRiskNotice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAA9A229-141D-5FBA-AC5C-516C02026A11\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"CertIdentifier\\": \\"1234\\",\\n \\"CertName\\": \\"test.com\\",\\n \\"CommonName\\": \\"*.test.com\\",\\n \\"Sans\\": \\"SSL\\",\\n \\"BeforeDate\\": \\"1694503184803\\",\\n \\"AfterDate\\": \\"1726039184803\\",\\n \\"Algorithm\\": \\"test\\",\\n \\"Issuer\\": \\"test\\",\\n \\"GmtBefore\\": \\"2023-09-12T07:19:44.803+0000\\",\\n \\"GmtAfter\\": \\"2024-09-11T07:19:44.803+0000\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListSSLCert', ], - 'ListGatewayDomain' => [ - 'summary' => 'Queries the domain names that are associated with a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'PreserveHeaderFormat' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '35641', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '142071', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'All', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****'], ], [ - 'name' => 'DomainName', + 'name' => 'PreserveHeaderFormat', 'in' => 'query', - 'schema' => [ - 'title' => '按域名模糊搜索', - 'type' => 'string', - 'example' => 'example.com', - ], + 'schema' => ['description' => 'Specifies whether the request header is case-sensitive. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => 'RestResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3F5D8E93-CA66-57F1-8BCF-A223E11B6B91', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the domain name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '243', - ], - 'Name' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - 'Protocol' => [ - 'description' => 'The protocol.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'MustHttps' => [ - 'description' => 'Indicates whether HTTPS is forcefully used.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => '3452-cn-hangzhou', - ], - 'CertBeforeDate' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'GatewayId' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'GmtCreate' => [ - 'description' => 'The time when the domain name was created.'."\n", - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'GmtModified' => [ - 'description' => 'The time when the domain name was updated.'."\n", - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'Status' => [ - 'description' => 'The state of the domain name. Valid values:'."\n" - ."\n" - .'* 0: unpublished'."\n" - .'* 2: publishing'."\n" - .'* 3: published'."\n" - .'* 4: editing'."\n" - .'* 5: unpublishing'."\n" - .'* 6: unavailable'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Type' => [ - 'description' => 'The type of the domain name source. Valid values:'."\n" - ."\n" - .'* Op: console'."\n" - .'* Ingress: MSE Ingress'."\n", - 'type' => 'string', - 'example' => 'Op', - ], - 'Comment' => [ - 'description' => 'The route comment. This parameter is returned only in ingress scenarios.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The route status.'."\n", - 'type' => 'string', - 'example' => 'Error', - ], - ], - ], - 'Http2' => [ - 'description' => 'Indicates whether `HTTP/2` is enabled.'."\n" - ."\n" - .'* `open`: `HTTP/2` is enabled.'."\n" - .'* `close`: `HTTP/2` is disabled.'."\n" - .'* `globalConfig`: Global configurations are used.'."\n", - 'type' => 'string', - 'example' => 'close', - ], - 'TlsMax' => [ - 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", - 'type' => 'string', - 'example' => 'TLS 1.3', - ], - 'TlsMin' => [ - 'description' => 'The minimum version of TLS.'."\n", - 'type' => 'string', - 'example' => 'TLS 1.0', - ], - 'IsManaged' => [ - 'title' => '是否为托管域名', - 'type' => 'boolean', - ], - 'TlsCipherSuitesConfig' => [ - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'type' => 'string', - ], - 'TlsCipherSuites' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'OK'], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> The request parameter **DtsJobId** is invalid if **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'PreserveHeaderFormat', + 'summary' => 'Specifies whether to convert all letters of a header into lowercase letters. For requests and responses, HTTP/1.1 headers are not case-sensitive. By default, all letters of headers are converted into lowercase letters.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:PreserveHeaderFormat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F5D8E93-CA66-57F1-8BCF-A223E11B6B91\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 243,\\n \\"Name\\": \\"test.com\\",\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"3452-cn-hangzhou\\",\\n \\"CertBeforeDate\\": \\" 2031-03-30 02:35:12\\",\\n \\"GatewayId\\": 12,\\n \\"GmtCreate\\": \\" 2031-03-30 02:35:12\\",\\n \\"GmtModified\\": \\" 2031-03-30 02:35:12\\",\\n \\"Status\\": 3,\\n \\"Type\\": \\"Op\\",\\n \\"Comment\\": {\\n \\"Status\\": \\"Error\\"\\n },\\n \\"Http2\\": \\"close\\",\\n \\"TlsMax\\": \\"TLS 1.3\\",\\n \\"TlsMin\\": \\"TLS 1.0\\",\\n \\"IsManaged\\": true,\\n \\"TlsCipherSuitesConfig\\": {\\n \\"ConfigType\\": \\"\\",\\n \\"TlsCipherSuites\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListGatewayDomain', ], - 'GetGatewayDomainDetail' => [ - 'summary' => 'Queries the details of a domain name associated with a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'PullServices' => [ + 'summary' => 'Queries information about services that can be imported from a specified source.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '35699', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'abilityTreeCode' => '25181', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'SourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The domain ID.'."\n", + 'description' => 'The type of the service source.', + 'enumValueTitles' => ['k8s' => 'services from a Kubernetes cluster.', 'MSE' => 'services from an MSE Nacos instance.'], 'type' => 'string', 'required' => false, - 'example' => '29', + 'example' => 'K8S', + 'title' => '', ], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-6d0b23e1d39e41658a968d79a635****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-eccf313e2224438ba53d95d039e5****', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'public', 'title' => ''], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the service source.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '88B83302-CD88-54D3-8DF2-208BFDC73F0D', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Specifies if the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Protocol' => [ - 'description' => 'The protocol of the gateway.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'MustHttps' => [ - 'description' => 'Indicates whether HTTPS is forcibly used.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'example' => '234-cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'CertName' => [ - 'description' => 'The name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CommonName' => [ - 'description' => 'The public domain name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Sans' => [ - 'description' => 'The name of the extended field.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - 'BeforeDate' => [ - 'description' => 'The expiration time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-04-01 02:35:12', - ], - 'AfterDate' => [ - 'description' => 'The start time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-04-01 02:35:12', - ], - 'Algorithm' => [ - 'description' => 'The algorithm.'."\n", - 'type' => 'string', - 'example' => 'RSA', - ], - 'Issuer' => [ - 'description' => 'The issuer.'."\n", - 'type' => 'string', - 'example' => 'Istio', - ], - 'GmtBefore' => [ - 'description' => 'The expiration time.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 02:35:12', - ], - 'GmtAfter' => [ - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 02:35:12', - ], - 'Http2' => [ - 'description' => 'Indicates whether `HTTP/2` is enabled.'."\n" - ."\n" - .'* `open`: `HTTP/2` is enabled.'."\n" - .'* `close`: `HTTP/2` is disabled.'."\n" - .'* `globalConfig`: Global configurations are used.'."\n", - 'type' => 'string', - 'example' => 'close', - ], - 'TlsMax' => [ - 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", - 'type' => 'string', - 'example' => 'TLS 1.3', - ], - 'TlsMin' => [ - 'description' => 'The minimum version of TLS.'."\n", - 'type' => 'string', - 'example' => 'TLS 1.0', - ], - 'IsManaged' => [ - 'title' => '是否为托管域名', - 'type' => 'boolean', - ], - 'TlsCipherSuitesConfig' => [ - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'type' => 'string', - ], - 'TlsCipherSuites' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'GroupName' => ['description' => 'The group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Services' => [ + 'description' => 'The service list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'GroupName' => ['description' => 'The group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SourceId' => ['description' => 'The source ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SourceType' => ['description' => 'The source type.', 'type' => 'string', 'example' => 'MSE', 'title' => ''], + 'SourceIdList' => [ + 'type' => 'array', + 'items' => ['description' => 'The service source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'description' => 'The service source ID list.', + 'title' => '', + 'example' => '', + ], + 'SaeAppId' => ['description' => 'The SAE application ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'NamespaceShowName' => ['description' => 'The namespace alias.', 'type' => 'string', 'example' => 'public', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"test\\",\\n \\"Services\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": \\"1\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"SourceIdList\\": [\\n 100\\n ],\\n \\"SaeAppId\\": \\"\\"\\n }\\n ],\\n \\"NamespaceShowName\\": \\"public\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'PullServices', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:PullServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88B83302-CD88-54D3-8DF2-208BFDC73F0D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 403,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test.com\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 1,\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"234-cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"CertName\\": \\"test\\",\\n \\"CommonName\\": \\"name\\",\\n \\"Sans\\": \\"test.com\\",\\n \\"BeforeDate\\": 0,\\n \\"AfterDate\\": 0,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"Issuer\\": \\"Istio\\",\\n \\"GmtBefore\\": \\"2021-04-01 02:35:12\\",\\n \\"GmtAfter\\": \\"2021-04-01 02:35:12\\",\\n \\"Http2\\": \\"close\\",\\n \\"TlsMax\\": \\"TLS 1.3\\",\\n \\"TlsMin\\": \\"TLS 1.0\\",\\n \\"IsManaged\\": true,\\n \\"TlsCipherSuitesConfig\\": {\\n \\"ConfigType\\": \\"\\",\\n \\"TlsCipherSuites\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayDomainDetail', ], - 'AddGateway' => [ - 'summary' => 'Adds a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'PutClusterHealthCheckTask' => [ + 'summary' => 'Initiates a task to check risk evaluation for an instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '24670', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '网关名称', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-ceshi', - ], - ], - [ - 'name' => 'Region', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The specifications of the internal-facing Server Load Balancer (SLB) instance. Valid values:'."\n" - ."\n" - .'* slb.s1.small'."\n" - .'* slb.s2.small'."\n" - .'* slb.s2.medium'."\n" - .'* slb.s3.small'."\n" - .'* slb.s3.medium'."\n" - .'* slb.s3.large'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-2r42o83h506', 'title' => ''], ], [ - 'name' => 'Vpc', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '专有网络ID', - 'description' => 'The ID of the primary vSwitch.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp15mncnrtm83uauxd1xb', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'ZoneInfo', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The details of the zone.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen-e', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp*****', - ], - ], - 'required' => false, + 'title' => 'RestResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'The data returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'title' => '主交换机ID', - 'description' => 'The ID of the primary vSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1q8th57frl5khj2li43', - ], - ], - [ - 'name' => 'VSwitchId2', - 'in' => 'query', - 'schema' => [ - 'title' => '备交换机ID', - 'description' => 'Specifies whether to use an advanced security group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-wz9bu6o5vsvitt5mrxo6s', + 'example' => '', ], ], - [ - 'name' => 'ChargeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method you specify when you purchase an ordinary instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PREPAY: subscription'."\n" - .'* POSTPAY: pay-as-you-go'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PREPAY' => '', - 'POSTPAY' => '', - ], - 'example' => 'POSTPAY', - 'enum' => [ - 'PREPAY', - 'POSTPAY', - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], - [ - 'name' => 'MserVersion', - 'in' => 'query', - 'schema' => [ - 'title' => '网关产品类型：'."\n" - .'- mse_pro：传统实例'."\n" - .'- mse_serverless：Serverless', - 'description' => 'The MSE instance type. Valid values:'."\n" - ."\n" - .'* mse_pro: ordinary instance'."\n" - .'* mse_serverless: serverless instance'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - 'default' => 'mse_pro', - 'enum' => [ - 'mse_premium', - 'mse_pro', - 'mse_serverless', - ], - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'Spec', - 'in' => 'query', - 'schema' => [ - 'title' => '节点规格', - 'description' => 'The node specifications you specify when you purchase an ordinary instance. Valid values:'."\n" - ."\n" - .'* MSE_GTW\\_16\\_32\\_200\\_c(16C32G)'."\n" - .'* MSE_GTW\\_2\\_4\\_200\\_c(2C4G)'."\n" - .'* MSE_GTW\\_4\\_8\\_200\\_c(4C8G)'."\n" - .'* MSE_GTW\\_8\\_16\\_200\\_c(8C16G)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MSE_GTW_16_32_200_c' => '16C32G', - 'MSE_GTW_2_4_200_c' => '2C4G', - 'MSE_GTW_4_8_200_c' => '4C8G', - 'MSE_GTW_8_16_200_c' => '8C16G', - ], - 'example' => 'MSE_GTW_2_4_200_c', - 'enum' => [ - 'MSE_GTW_2_4_200_c', - 'MSE_GTW_4_8_200_c', - 'MSE_GTW_8_16_200_c', - 'MSE_GTW_16_32_200_c', - ], - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], - [ - 'name' => 'Replica', - 'in' => 'query', - 'schema' => [ - 'title' => '节点数量', - 'description' => 'The number of nodes you specify when you purchase an ordinary instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'PutClusterHealthCheckTask', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ManagedEntryNetworkType', - 'in' => 'query', - 'schema' => [ - 'title' => '网关入口类型（普通实例专业版适用）', - 'type' => 'string', - 'example' => 'pubnet', - 'enum' => [ - 'pubnet', - 'privatenet', - 'privatepubnet', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:PutClusterHealthCheckTask', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], + ], + ], + 'QueryAllSwimmingLane' => [ + 'summary' => 'Queries information about all lanes.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'NlbNetworkType', - 'in' => 'query', - 'schema' => [ - 'title' => '代购NLB的网络类型：'."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网', - 'description' => 'The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance.'."\n" - ."\n" - .'* pubnet: Internet'."\n" - .'* privatenet: private network'."\n" - .'* privatepubnet: Internet and private network'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pubnet', - 'enum' => [ - 'pubnet', - 'privatenet', - 'privatepubnet', - ], - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116125', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], + ], + 'parameters' => [ [ - 'name' => 'ClbNetworkType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '代购按LCU计费的CLB的网络类型：'."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网', - 'description' => 'The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs.'."\n" - ."\n" - .'* pubnet: Internet'."\n" - .'* privatenet: private network'."\n" - .'* privatepubnet: Internet and private network'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pubnet', - 'enum' => [ - 'pubnet', - 'privatenet', - 'privatepubnet', - ], - ], + 'schema' => ['description' => 'The name of the MSE namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'SlbSpec', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '内网SLB规格', - 'description' => 'The specifications of the internal-facing Server Load Balancer (SLB) instance. Valid values:'."\n" - ."\n" - .'* slb.s1.small'."\n" - .'* slb.s2.small'."\n" - .'* slb.s2.medium'."\n" - .'* slb.s3.small'."\n" - .'* slb.s3.medium'."\n" - .'* slb.s3.large'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'slb.s2.small', - 'deprecated' => true, - ], + 'schema' => ['description' => 'The ID of the lane group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '186', 'title' => ''], ], [ - 'name' => 'InternetSlbSpec', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '外网SLB规格', - 'description' => 'The specifications of the Internet-facing Server Load Balancer (SLB) instance. Valid values:'."\n" - ."\n" - .'* slb.s1.small'."\n" - .'* slb.s2.smal'."\n" - .'* slb.s2.medium'."\n" - .'* slb.s3.small'."\n" - .'* slb.s3.medium'."\n" - .'* slb.s3.large'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'slb.s2.small', - 'deprecated' => true, - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], - [ - 'name' => 'EnterpriseSecurityGroup', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否企业安全组类型', - 'description' => 'Specifies whether to enable hardware acceleration.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'description' => 'Data Overview.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the lane group.', 'type' => 'string', 'example' => 'swimmingGroup', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to which the lane belongs.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'MessageQueueFilterSide' => ['description' => 'The side on which canary release for messages is implemented.', 'type' => 'string', 'example' => 'Client', 'title' => ''], + 'Enable' => ['title' => '是否开启。', 'description' => 'Indicates whether the lane is enabled.', 'type' => 'string', 'example' => 'true'], + 'Namespace' => ['description' => 'The MSE namespace to which the lane belongs.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'RecordCanaryDetail' => ['description' => 'Indicates whether to record the request details. This is for the observability of end-to-end canary releases.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Id' => ['description' => 'The lane ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'MessageQueueGrayEnable' => ['description' => 'Indicates whether canary release for messages is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'enableRules' => ['description' => 'Indicates whether rules are enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EntryRules' => [ + 'description' => 'The list of rules for the ingress application.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule for the ingress application.', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => 'The list of paths.', + 'type' => 'array', + 'items' => ['description' => 'The path.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'path' => ['description' => 'The path.', 'type' => 'string', 'title' => '', 'example' => '/adump/wxb/prod'], + 'condition' => ['description' => 'The condition.', 'type' => 'string', 'example' => 'AND', 'title' => ''], + 'restItems' => [ + 'description' => 'The list of RESTful matching rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The RESTful matching rule.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The matching type.', 'type' => 'string', 'title' => '', 'example' => 'cookie'], + 'name' => ['description' => 'The name.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'operator' => ['description' => 'The operator.', 'type' => 'string', 'title' => '', 'example' => 'rawvalue'], + 'nameList' => [ + 'title' => '', + 'description' => 'The list of items to match.', + 'type' => 'array', + 'items' => ['description' => 'The name of the item to match.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'maxItems' => 10, + 'example' => '', + ], + 'datum' => ['description' => 'The value.', 'type' => 'string', 'title' => '', 'example' => 'x'], + 'cond' => ['description' => 'The matching operator.', 'type' => 'string', 'title' => '', 'example' => '=='], + 'divisor' => ['description' => 'The divisor.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'remainder' => ['description' => 'The remainder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'rate' => ['description' => 'The percentage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'value' => ['description' => 'The value.', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'gmtCreate' => ['description' => 'The time when the lane was created.', 'type' => 'string', 'title' => '', 'example' => '1683598484000'], + 'gmtModified' => ['description' => 'The time when the lane was last updated.', 'type' => 'string', 'title' => '', 'example' => '1683598484000'], + 'groupId' => ['description' => 'The ID of the lane group.', 'type' => 'string', 'title' => '', 'example' => '72709'], + 'GroupId' => ['description' => 'The ID of the lane group.', 'type' => 'string', 'title' => '', 'example' => '6859'], + 'tag' => ['description' => 'The tag of the lane.', 'type' => 'string', 'title' => '', 'example' => 'gray'], + 'Tag' => ['description' => 'The tag of the lane.', 'type' => 'string', 'title' => '', 'example' => 'gray'], + 'GatewaySwimmingLaneRoute' => [ + 'title' => '网关路由信息（使用云原生网关为入口时使用）', + 'description' => 'The information about the gateway route. This parameter is used when a cloud-native gateway or an API Gateway instance is used as the ingress.', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['title' => '网关ID', 'description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GatewayUniqueId' => ['title' => '网关唯一ID', 'description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-84efde2ee1464260bdb17a5b****'], + 'RouteIdList' => [ + 'title' => '路由ID列表', + 'description' => 'The list of route IDs. This parameter is optional if the canary release is effective at the gateway level.', + 'type' => 'array', + 'items' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'example' => '', + ], + 'CanaryModel' => ['title' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'description' => 'The mode of the end-to-end canary release. Valid values:'."\n" + ."\n" + .'- 0: route by the content of the request'."\n" + ."\n" + .'- 1: route by proportion', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Conditions' => [ + 'title' => '匹配条件列表（按内容路由使用）', + 'description' => 'The list of matching conditions. This parameter is used when you route requests by content.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The matching condition.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '参数名称', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'name'], + 'Value' => ['title' => '参数值', 'description' => 'The parameter value.', 'type' => 'string', 'example' => 'xiaoming'], + 'Type' => ['title' => '参数类型：'."\n" + .'- header：Header'."\n" + .'- param：Parameter', 'description' => 'The parameter type. Valid values:'."\n" + ."\n" + .'- header: Header'."\n" + ."\n" + .'- param: Parameter', 'type' => 'string', 'example' => 'header'], + 'Cond' => ['title' => '条件：'."\n" + .'- PRE：前缀匹配'."\n" + .'- EQUAL：精确匹配'."\n" + .'- ERGULAR：正则匹配', 'description' => 'The condition. Valid values:'."\n" + ."\n" + .'- PRE: prefix match'."\n" + ."\n" + .'- EQUAL: exact match'."\n" + ."\n" + .'- REGULAR: regular expression match', 'type' => 'string', 'example' => 'PRE'], + 'NameList' => [ + 'description' => 'NameList', + 'type' => 'array', + 'items' => ['description' => 'Name', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Percentage' => ['title' => '流量比例（按比例路由使用，取值0-100）', 'description' => 'The traffic proportion. This parameter is used when you route requests by proportion. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'RouteIndependentPercentageEnable' => ['description' => 'Indicates whether to independently set the percentage for each path.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RouteIndependentPercentageList' => [ + 'description' => 'The list of routes and percentages.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteId' => ['description' => 'The route ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Percentage' => ['description' => 'The percentage.', 'type' => 'string', 'example' => '60', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Condition' => ['description' => 'The condition for the canary release.', 'type' => 'string', 'example' => 'AND、OR', 'title' => ''], + ], + 'example' => '', + ], + 'PathIndependentPercentageEnable' => ['description' => 'Indicates whether to set the percentage for each path.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GatewaySwimmingLaneRouteJson' => ['description' => 'The information about the gateway. This parameter is used when an MSE cloud-native gateway or a cloud-native API Gateway instance is used as the ingress.', 'type' => 'string', 'example' => '{\\"GatewayUniqueId\\":\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\",\\"Percentage\\":0,\\"RouteIdList\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\"CanaryModel\\":1,\\"Conditions\\":[]}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[{id:100,name:"test"}]', + 'title' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'EnableHardwareAcceleration', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启硬件加速', - 'description' => 'Specifies whether to activate Tracing Analysis.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], - [ - 'name' => 'EnableXtrace', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启xtrace', - 'description' => 'The sampling rate of Tracing Analysis. Valid values: \\[1,100].'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'XtraceRatio', - 'in' => 'query', - 'schema' => [ - 'title' => 'xtrace采样率，取值[0,100]', - 'description' => 'Specifies whether to activate Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], - [ - 'name' => 'EnableSls', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启SLS日志投递', - 'description' => 'The tag of the gateway.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"swimmingGroup\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"Enable\\": \\"true\\",\\n \\"Namespace\\": \\"default\\",\\n \\"RecordCanaryDetail\\": false,\\n \\"Id\\": 123,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": false,\\n \\"enableRules\\": true,\\n \\"EntryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/adump/wxb/prod\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"test\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"test\\"\\n }\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"1683598484000\\",\\n \\"gmtModified\\": \\"1683598484000\\",\\n \\"groupId\\": \\"72709\\",\\n \\"GroupId\\": \\"6859\\",\\n \\"tag\\": \\"gray\\",\\n \\"Tag\\": \\"gray\\",\\n \\"GatewaySwimmingLaneRoute\\": {\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-84efde2ee1464260bdb17a5b****\\",\\n \\"RouteIdList\\": [\\n 1\\n ],\\n \\"CanaryModel\\": 0,\\n \\"Conditions\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Value\\": \\"xiaoming\\",\\n \\"Type\\": \\"header\\",\\n \\"Cond\\": \\"PRE\\",\\n \\"NameList\\": [\\n \\"name\\"\\n ]\\n }\\n ],\\n \\"Percentage\\": 20,\\n \\"RouteIndependentPercentageEnable\\": \\"true\\",\\n \\"RouteIndependentPercentageList\\": [\\n {\\n \\"RouteId\\": \\"12345\\",\\n \\"Percentage\\": \\"60\\"\\n }\\n ],\\n \\"Condition\\": \\"AND、OR\\"\\n },\\n \\"PathIndependentPercentageEnable\\": true,\\n \\"GatewaySwimmingLaneRouteJson\\": \\"{\\\\\\\\\\\\\\"GatewayUniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"RouteIdList\\\\\\\\\\\\\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\\\\\\\\\\\\\"CanaryModel\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Conditions\\\\\\\\\\\\\\":[]}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryAllSwimmingLane', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => 'The tag object.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], ], - 'required' => false, - 'maxItems' => 21, ], ], + ], + ], + 'QueryAllSwimmingLaneGroup' => [ + 'summary' => 'Queries all lane groups.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm34x43l*****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116120', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The name of the MSE namespace to query.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The ID of the request.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C', - ], - 'HttpStatusCode' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The request is successfully processed.'."\n", - 'type' => 'string', - 'example' => 'The return value.'."\n", - ], - 'Code' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The code is used only to synchronize with success.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message that is returned for the request.'."\n" + ."\n" + .'- If the request is successful, a success message is returned.'."\n" + ."\n" + .'- If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message.', 'type' => 'string', 'title' => '', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'object', - 'properties' => [ - 'GatewayUniqueId' => [ - 'description' => 'code', - 'type' => 'string', - 'example' => 'gw-5017305290e14cebbrvec4a5****', + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of a lane group.', 'type' => 'string', 'example' => 'swimmingGroup', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to which the lane belongs.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'MessageQueueFilterSide' => ['description' => 'The side at which canary release for messaging is enabled.', 'type' => 'string', 'example' => 'Client', 'title' => ''], + 'AppIds' => ['description' => 'The application IDs.', 'type' => 'string', 'example' => 'abcde@abcde,abcde@abcde', 'title' => ''], + 'Namespace' => ['description' => 'The MSE namespace to which the lane belongs.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'RecordCanaryDetail' => ['description' => 'Indicates whether to record the request details (metrics of end-to-end canary release).', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Id' => ['description' => 'The ID of the lane group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'EntryApp' => ['description' => 'The type of the ingress application and the ID of the ingress application.', 'type' => 'string', 'example' => 'mse:abcde@abcde', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'MessageQueueGrayEnable' => ['description' => 'Indicates whether canary release for messaging is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Paths' => ['description' => 'This parameter is deprecated', 'type' => 'string', 'example' => '["/a"]', 'title' => ''], + 'paths' => ['description' => 'This parameter is deprecated', 'type' => 'string', 'example' => '["/a"]', 'title' => ''], + 'CanaryModel' => ['description' => 'The routing mode for end-to-end canary release:'."\n" + ."\n" + .'- 0: routing based on request content'."\n" + ."\n" + .'- 1: routing based on percentages', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'canaryModel' => ['description' => 'The routing mode for end-to-end canary release:'."\n" + ."\n" + .'- 0: routing based on request content'."\n" + ."\n" + .'- 1: routing based on percentages', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SwimVersion' => ['description' => 'The canary version. Valid values: 0 and 2. Recommended value: 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'swimVersion' => ['description' => 'The canary version. Valid values: 0 and 2. Recommended value: 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '[{id:100,name:"test"}]'."\n", + 'title' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"swimmingGroup\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"AppIds\\": \\"abcde@abcde,abcde@abcde\\",\\n \\"Namespace\\": \\"default\\",\\n \\"RecordCanaryDetail\\": false,\\n \\"Id\\": 123,\\n \\"EntryApp\\": \\"mse:abcde@abcde\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": true,\\n \\"Paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"CanaryModel\\": 0,\\n \\"canaryModel\\": 0,\\n \\"SwimVersion\\": 2,\\n \\"swimVersion\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryAllSwimmingLaneGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebbrvec4a5****\\"\\n }\\n}","type":"json"}]', - 'title' => 'AddGateway', ], - 'ListGatewayZone' => [ - 'summary' => 'Obtains a list of zones where a gateway is available.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryBusinessLocations' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['common'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '174557', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'NO_PERMISSION', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'DynamicCode' => [ - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace %s in **ErrMessage**.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The parameter is invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', 'title' => ''], 'Data' => [ - 'description' => 'The queried zones.'."\n", + 'description' => 'The details of the data.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned information.'."\n", 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'LocalName' => [ - 'description' => 'The local name of the zone.'."\n", - 'type' => 'string', - 'example' => 'I', - ], - 'SupportQat' => [ - 'type' => 'boolean', - ], + 'Ordering' => ['description' => 'The ordering information.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'Type' => ['description' => 'The type.'."\n", 'type' => 'string', 'example' => 'region', 'title' => ''], + 'DistrictEnName' => ['description' => 'The English name of the district.'."\n", 'type' => 'string', 'example' => 'Asia Pacific', 'title' => ''], + 'ShowName' => ['description' => 'The display name.'."\n", 'type' => 'string', 'example' => 'China (Shanghai)', 'title' => ''], + 'DistrictCnName' => ['description' => 'The Chinese name of the district.'."\n", 'type' => 'string', 'example' => '亚太', 'title' => ''], + 'EnName' => ['description' => 'The English name of the region.'."\n", 'type' => 'string', 'example' => 'China (Shanghai)', 'title' => ''], + 'DistrictId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'asia-pacific', 'title' => ''], + 'DistrictShowName' => ['description' => 'The display name of the district.'."\n", 'type' => 'string', 'example' => 'Asia Pacific', 'title' => ''], + 'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'China (Shanghai)', 'title' => ''], + 'EnDescription' => ['description' => 'The complete description of the region.'."\n", 'type' => 'string', 'example' => 'China East 2 (Shanghai)', 'title' => ''], + 'CnName' => ['description' => 'The Chinese name of the region.'."\n", 'type' => 'string', 'example' => '华东2（上海）', 'title' => ''], + 'Name' => ['description' => 'The name.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'DistrictOrdering' => ['description' => 'The ordering information of the district.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '101', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'The result of the request.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"LocalName\\": \\"I\\",\\n \\"SupportQat\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListGatewayZone', - ], - 'AddGatewaySlb' => [ - 'summary' => 'Associates a Server Load Balancer (SLB) instance with a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The parameter is invalid.\\",\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Data\\": [\\n {\\n \\"Ordering\\": 6,\\n \\"Type\\": \\"region\\",\\n \\"DistrictEnName\\": \\"Asia Pacific\\",\\n \\"ShowName\\": \\"China (Shanghai)\\",\\n \\"DistrictCnName\\": \\"亚太\\",\\n \\"EnName\\": \\"China (Shanghai)\\",\\n \\"DistrictId\\": \\"asia-pacific\\",\\n \\"DistrictShowName\\": \\"Asia Pacific\\",\\n \\"Description\\": \\"China (Shanghai)\\",\\n \\"EnDescription\\": \\"China East 2 (Shanghai)\\",\\n \\"CnName\\": \\"华东2（上海）\\",\\n \\"Name\\": \\"cn-shanghai\\",\\n \\"DistrictOrdering\\": 101\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryBusinessLocations', + 'summary' => 'Queries information about regions.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2026-02-27T05:55:07.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-02-27T05:54:51.000Z', 'description' => 'OpenAPI offline'], ], + 'ramActions' => [], + ], + 'QueryClusterDetail' => [ + 'summary' => 'Queries the details of a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '71795', - 'abilityTreeNodes' => [ - 'FEATUREmseMNDRFM', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17078', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'SlbId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the SLB instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'lb-bp18t6jjskwxh6wy1****', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-st21ri2****', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service source. Valid values:'."\n" - ."\n" - .'* PUB_NET: Internet'."\n" - .'* PRIVATE_NET: VPC'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PUB_NET', - ], + 'schema' => ['description' => 'The ID of the order.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '20576750143****', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'AclSwitch', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', - ], + 'schema' => ['description' => 'Specifies whether to query the access control list (ACL).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'VServerGroupId', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the HTTP virtual service group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '353', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], - [ - 'name' => 'ServiceWeight', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The service weight.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', + 'description' => 'The data returned by the request.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the cluster.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1hcg467ekqsv0zr****', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the cluster.', 'type' => 'string', 'example' => '2020-07-31 11:36:08', 'title' => ''], + 'IntranetAddress' => ['description' => 'The private address.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'DiskType' => ['description' => 'The disk type.', 'type' => 'string', 'example' => 'alicloud-disk-ssd-multi-zone', 'title' => ''], + 'PubNetworkFlow' => ['description' => 'The public bandwidth in Mbit/s.
'."\n" + .'The value is an integer from 0 to 5,000. A value of 0 indicates that the cluster is not accessible over the public network.
', 'type' => 'string', 'example' => '3', 'title' => ''], + 'DiskCapacity' => ['description' => 'The disk capacity in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'MemoryCapacity' => ['description' => 'The memory capacity in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ClusterAliasName' => ['description' => 'The alias of the cluster.', 'type' => 'string', 'example' => 'mse-7413****', 'title' => ''], + 'InstanceCount' => ['description' => 'The number of instances in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'IntranetPort' => ['description' => 'The private port.', 'type' => 'string', 'example' => '8761', 'title' => ''], + 'InstanceModels' => [ + 'description' => 'The list of instances in the cluster.', + 'type' => 'array', + 'items' => [ + 'description' => 'An instance in the cluster.', + 'type' => 'object', + 'properties' => [ + 'PodName' => ['description' => 'The name of the pod.', 'type' => 'string', 'example' => 'mse-7413****-159616656****-reg-center-0-0', 'title' => ''], + 'SingleTunnelVip' => ['description' => 'The virtual IP address (VIP) of a single tunnel.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'InternetIp' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '47.98.XX.XX', 'title' => ''], + 'Ip' => ['description' => 'The IP address of the instance.', 'type' => 'string', 'example' => '10.12.XX.XX', 'title' => ''], + 'Role' => ['description' => 'The role of the instance.', 'type' => 'string', 'example' => 'Peer', 'title' => ''], + 'HealthStatus' => ['description' => 'The health status of the instance.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'CreationTimestamp' => ['description' => 'The Unix timestamp, in milliseconds, that indicates when the instance was created.', 'type' => 'string', 'example' => '1578575377732', 'title' => ''], + 'Zone' => ['description' => 'The availability zone where the instance is located.', 'type' => 'string', 'example' => 'cn-shanghai-f', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'IntranetDomain' => ['description' => 'The private domain name.', 'type' => 'string', 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', 'title' => ''], + 'InternetDomain' => ['description' => 'The public domain name.', 'type' => 'string', 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', 'title' => ''], + 'PayInfo' => ['description' => 'Specifies the billing method, which is either `subscription` or `pay-as-you-go`.', 'type' => 'string', 'example' => 'Pay-as-you-go', 'title' => ''], + 'InternetAddress' => ['description' => 'The public address.', 'type' => 'string', 'example' => '47.98.XX.XX', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'AclEntryList' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'HealthStatus' => ['description' => 'The health status of the cluster.', 'type' => 'string', 'example' => 'RESTART_SUCCESS', 'title' => ''], + 'InitCostTime' => ['description' => 'The time it took to create the cluster, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '98408', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AclId' => ['description' => 'The ID of the whitelist.', 'type' => 'string', 'example' => 'acl-bp17020kiqvzutwwj****', 'title' => ''], + 'Cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the cluster. Valid values: `ZooKeeper`, `Nacos-Ans`, and `Eureka`.', 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], + 'ClusterName' => ['description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****', 'title' => ''], + 'InitStatus' => ['description' => 'The creation status of the cluster.', 'type' => 'string', 'example' => 'RESTART_SUCCESS', 'title' => ''], + 'InternetPort' => ['description' => 'The public port.', 'type' => 'string', 'example' => '8761', 'title' => ''], + 'AppVersion' => ['description' => 'The application version.', 'type' => 'string', 'example' => '1.2.1', 'title' => ''], + 'NetType' => ['description' => 'The network type. Valid values:'."\n" + ."\n" + .'- `privatenet`: The cluster is deployed in a VPC.'."\n" + ."\n" + .'- `pubnet`: The cluster is accessible over the public network.', 'type' => 'string', 'example' => 'privatenet', 'title' => ''], + 'ClusterVersion' => ['description' => 'The version of the cluster.', 'type' => 'string', 'example' => '1.2.1', 'title' => ''], + 'ClusterSpecification' => ['description' => 'The specifications of the cluster.', 'type' => 'string', 'example' => 'MSE_SC_1_2_200_c', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-xxx-xxxx', 'title' => ''], + 'ConnectionType' => ['description' => 'The network connection type. Valid values:'."\n" + ."\n" + .'- `slb`: Server Load Balancer (SLB)'."\n" + ."\n" + .'- `eni`: Elastic Network Interface (ENI)', 'type' => 'string', 'example' => 'slb', 'title' => ''], + 'MseVersion' => ['description' => 'The edition of the Microservices Engine (MSE) instance.', 'type' => 'string', 'example' => 'mse_basic', 'title' => ''], + 'ChargeType' => ['description' => 'Specifies the billing method, which is either `subscription` or `pay-as-you-go`.', 'type' => 'string', 'example' => 'Pay-as-you-go', 'title' => ''], + 'OrderClusterVersion' => ['description' => 'The originally purchased cluster version.', 'type' => 'string', 'example' => '1.2.0', 'title' => ''], + 'Tags' => ['description' => 'The tags attached to the instance.', 'type' => 'object', 'title' => '', 'example' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek2dhgysj*****', 'title' => ''], + 'VersionLifecycle' => ['description' => 'The lifecycle status of the cluster version.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'HttpPort', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP port number (virtual service group).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"9515ACA4-E94D-440D-989E-C379FCED****\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-bp1hcg467ekqsv0zr****\\",\\n \\"CreateTime\\": \\"2020-07-31 11:36:08\\",\\n \\"IntranetAddress\\": \\"192.168.XX.XX\\",\\n \\"DiskType\\": \\"alicloud-disk-ssd-multi-zone\\",\\n \\"PubNetworkFlow\\": \\"3\\",\\n \\"DiskCapacity\\": 60,\\n \\"MemoryCapacity\\": 2,\\n \\"ClusterAliasName\\": \\"mse-7413****\\",\\n \\"InstanceCount\\": 3,\\n \\"IntranetPort\\": \\"8761\\",\\n \\"InstanceModels\\": [\\n {\\n \\"PodName\\": \\"mse-7413****-159616656****-reg-center-0-0\\",\\n \\"SingleTunnelVip\\": \\"192.168.XX.XX\\",\\n \\"InternetIp\\": \\"47.98.XX.XX\\",\\n \\"Ip\\": \\"10.12.XX.XX\\",\\n \\"Role\\": \\"Peer\\",\\n \\"HealthStatus\\": \\"Running\\",\\n \\"CreationTimestamp\\": \\"1578575377732\\",\\n \\"Zone\\": \\"cn-shanghai-f\\"\\n }\\n ],\\n \\"IntranetDomain\\": \\"mse-7413****-eureka.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-7413****-p.eureka.mse.aliyuncs.com\\",\\n \\"PayInfo\\": \\"Pay-as-you-go\\",\\n \\"InternetAddress\\": \\"47.98.XX.XX\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"AclEntryList\\": \\"[]\\",\\n \\"HealthStatus\\": \\"RESTART_SUCCESS\\",\\n \\"InitCostTime\\": 98408,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AclId\\": \\"acl-bp17020kiqvzutwwj****\\",\\n \\"Cpu\\": 1,\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"ClusterName\\": \\"mse-bc1a29b0-160230875****\\",\\n \\"InitStatus\\": \\"RESTART_SUCCESS\\",\\n \\"InternetPort\\": \\"8761\\",\\n \\"AppVersion\\": \\"1.2.1\\",\\n \\"NetType\\": \\"privatenet\\",\\n \\"ClusterVersion\\": \\"1.2.1\\",\\n \\"ClusterSpecification\\": \\"MSE_SC_1_2_200_c\\",\\n \\"VSwitchId\\": \\"vsw-xxx-xxxx\\",\\n \\"ConnectionType\\": \\"slb\\",\\n \\"MseVersion\\": \\"mse_basic\\",\\n \\"ChargeType\\": \\"Pay-as-you-go\\",\\n \\"OrderClusterVersion\\": \\"1.2.0\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ResourceGroupId\\": \\"rg-aek2dhgysj*****\\",\\n \\"VersionLifecycle\\": \\"\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryClusterDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'HttpsPort', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTPS port number (virtual service group).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'QueryClusterDiskSpecification' => [ + 'summary' => 'Queries disk specifications that are supported by an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'HttpsVServerGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the HTTPS virtual service group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '353', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76161', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], + ], + 'parameters' => [ [ - 'name' => 'VServiceList', + 'name' => 'ClusterType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The SLB monitoring information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VServerGroupId' => [ - 'description' => 'The ID of the virtual server group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rsp-bp1j**t0fyl**', - ], - 'VServerGroupName' => [ - 'description' => 'The name of the virtual server group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'k8s/31**0/***/istio-system/clusterid', - ], - 'Port' => [ - 'description' => 'The port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', - ], - 'Protocol' => [ - 'description' => 'The protocol type. Valid values:'."\n" - ."\n" - .'* HTTP'."\n" - .'* HTTPS'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ZooKeeper', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E13A3A34-7201-50C4-B2D0-0D7DB891811E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'string', - 'example' => 'lb-uf6dqr4ondqi5w3df7hdf', + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'The step size of the disk capacity.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Max' => ['description' => 'The maximum disk capacity. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'Min' => ['description' => 'The minimum disk capacity. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E13A3A34-7201-50C4-B2D0-0D7DB891811E\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Step\\": 2,\\n \\"Max\\": 500,\\n \\"Min\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'QueryClusterDiskSpecification', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDiskSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"lb-uf6dqr4ondqi5w3df7hdf\\"\\n}","type":"json"}]', - 'title' => 'AddGatewaySlb', ], - 'AddSecurityGroupRule' => [ - 'summary' => 'Creates a security group rule for a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryClusterInfo' => [ + 'summary' => 'Queries the static information about a cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '129315', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'SecurityGroupId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '安全组ID', - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sg-wz929kxhcdpw9z8idqd8', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ - 'name' => 'PortRange', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '端口范围', - 'description' => 'The range of port numbers.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1/65535', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-7mz2t63ci03', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID', - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], + 'schema' => ['description' => 'The order ID.', 'type' => 'string', 'required' => false, 'example' => '20574710974****', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'AclSwitch', 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => 'Indicates whether to query the public network whitelist.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'The data structure of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.'."\n" + ."\n" + .'- A success message is returned for a successful request.'."\n" + ."\n" + .'- An error message is returned for a failed request.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '415088B3-A7BE-56F6-9CD9-C42DE895CD41', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '12', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'The ID of the VPC that contains the cluster.', 'type' => 'string', 'example' => 'vpc-bp1v5nbauzh8xxxxxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The time the cluster was created.', 'type' => 'string', 'example' => '2022-12-15 10:02:07', 'title' => ''], + 'IntranetAddress' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DiskType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'PubNetworkFlow' => ['description' => 'The public bandwidth in Mbps.
Valid values: 0 to 5000. A value of 0 indicates that the public endpoint is disabled.
', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DiskCapacity' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', 'title' => ''], + 'MemoryCapacity' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', 'title' => ''], + 'ClusterAliasName' => ['description' => 'The alias of the cluster.', 'type' => 'string', 'example' => 'Development environment', 'title' => ''], + 'InstanceCount' => ['description' => 'The number of instances in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'IntranetPort' => ['description' => 'The ports that are open on the cluster\'s internal network.', 'type' => 'string', 'example' => '8848,6443,9848,8761', 'title' => ''], + 'InstanceModels' => [ + 'description' => 'This parameter is reserved.', + 'type' => 'array', + 'items' => [ + 'description' => 'This parameter is reserved.', + 'type' => 'object', + 'properties' => [ + 'PodName' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'SingleTunnelVip' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'InternetIp' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Ip' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Role' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HealthStatus' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'CreationTimestamp' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Zone' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'IntranetDomain' => ['description' => 'The cluster\'s internal domain name.', 'type' => 'string', 'example' => 'mse-xxxxx-nacos-ans.mse.aliyuncs.com', 'title' => ''], + 'InternetDomain' => ['description' => 'The cluster\'s public domain name.', 'type' => 'string', 'example' => 'mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com', 'title' => ''], + 'PayInfo' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'Pay-as-you-go', 'title' => ''], + 'InternetAddress' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'mse-cn-st21ri2****', 'title' => ''], + 'AclEntryList' => ['description' => 'The IP whitelist for public access.', 'type' => 'string', 'example' => '["127.0.0.0/32"]', 'title' => ''], + 'HealthStatus' => ['description' => 'The health status of the cluster.', 'type' => 'string', 'example' => 'INIT_SUCCESS', 'title' => ''], + 'InitCostTime' => ['description' => 'The time taken to initialize the cluster, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '53353', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AclId' => ['description' => 'The ID of the public access IP whitelist.', 'type' => 'string', 'example' => 'acl-bp144q24cgqvzckmxxxx', 'title' => ''], + 'Cpu' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the cluster. Valid values: `ZooKeeper`, `Nacos-Ans`, and `Eureka`.', 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], + 'ClusterName' => ['description' => 'The cluster\'s full name.', 'type' => 'string', 'example' => 'mse-74355150-xxxxxxx', 'title' => ''], + 'InitStatus' => ['description' => 'The initialization status of the cluster.', 'type' => 'string', 'example' => 'INIT_SUCCESS', 'title' => ''], + 'InternetPort' => ['description' => 'The ports that are open on the cluster\'s public network.', 'type' => 'string', 'example' => '8848,6443,9848,8761', 'title' => ''], + 'AppVersion' => ['description' => 'The cluster version.', 'type' => 'string', 'example' => '2.1.0', 'title' => ''], + 'NetType' => ['description' => 'The cluster\'s network connection type.', 'type' => 'string', 'example' => 'privatenet', 'title' => ''], + 'ClusterVersion' => ['description' => 'The cluster edition.', 'type' => 'string', 'example' => 'NACOS_2_0_0', 'title' => ''], + 'ClusterSpecification' => ['description' => 'The cluster\'s engine specification.', 'type' => 'string', 'example' => 'MSE_SC_2_4_60_c', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp1egfakxxxxx', 'title' => ''], + 'ConnectionType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MseVersion' => ['description' => 'The edition of the MSE instance.', 'type' => 'string', 'example' => 'mse_pro', 'title' => ''], + 'ChargeType' => ['description' => 'The cluster\'s billing method. Valid values: `PREPAY` (subscription) and `POSTPAY` (pay-as-you-go).', 'type' => 'string', 'title' => '', 'example' => 'POSTPAY'], + 'Tags' => ['description' => 'The tags attached to the cluster.', 'type' => 'object', 'title' => '', 'example' => ''], + 'ExpectZones' => [ + 'description' => 'A list of availability zones in which the cluster can be deployed.', + 'type' => 'array', + 'items' => ['description' => 'An availability zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MaintenancePeriod' => [ + 'description' => 'The maintenance window.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '02:00', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '06:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EndDate' => ['description' => 'The expiration date of the subscription-based cluster.', 'type' => 'string', 'title' => '', 'example' => '2021-08-01 00:00:00'], + 'SecurityGroupId' => ['description' => 'The security group ID of the Elastic Network Interface (ENI).', 'type' => 'string', 'title' => '', 'example' => 'sg-uf6hgwe067prhg68agfa'], + 'SecurityGroupType' => [ + 'description' => 'The type of the security group for the ENI.', + 'type' => 'string', + 'enum' => ['enterprise', 'normal'], + 'title' => '', + 'example' => 'enterprise', + ], + 'EipInstanceId' => ['description' => 'The instance ID of the Elastic IP Address (EIP).', 'type' => 'string', 'title' => '', 'example' => 'eip-bp1uujshd5funmyy8rcl9'], + 'CanUpdate' => ['description' => 'Indicates whether the cluster can be upgraded to a later minor version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'VersionCode' => ['description' => 'The current version code of the cluster.', 'type' => 'string', 'example' => 'NACOS_2_1_0_1', 'title' => ''], + 'VersionLifecycle' => ['description' => 'The version lifecycle.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"415088B3-A7BE-56F6-9CD9-C42DE895CD41\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-bp1v5nbauzh8xxxxxxx\\",\\n \\"CreateTime\\": \\"2022-12-15 10:02:07\\",\\n \\"IntranetAddress\\": \\"null\\",\\n \\"DiskType\\": \\"null\\",\\n \\"PubNetworkFlow\\": \\"1\\",\\n \\"DiskCapacity\\": 0,\\n \\"MemoryCapacity\\": 0,\\n \\"ClusterAliasName\\": \\"Development environment\\",\\n \\"InstanceCount\\": 3,\\n \\"IntranetPort\\": \\"8848,6443,9848,8761\\",\\n \\"InstanceModels\\": [\\n {\\n \\"PodName\\": \\"null\\",\\n \\"SingleTunnelVip\\": \\"null\\",\\n \\"InternetIp\\": \\"null\\",\\n \\"Ip\\": \\"null\\",\\n \\"Role\\": \\"null\\",\\n \\"HealthStatus\\": \\"null\\",\\n \\"CreationTimestamp\\": \\"null\\",\\n \\"Zone\\": \\"null\\"\\n }\\n ],\\n \\"IntranetDomain\\": \\"mse-xxxxx-nacos-ans.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com\\",\\n \\"PayInfo\\": \\"Pay-as-you-go\\",\\n \\"InternetAddress\\": \\"null\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"AclEntryList\\": \\"[\\\\\\"127.0.0.0/32\\\\\\"]\\",\\n \\"HealthStatus\\": \\"INIT_SUCCESS\\",\\n \\"InitCostTime\\": 53353,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AclId\\": \\"acl-bp144q24cgqvzckmxxxx\\",\\n \\"Cpu\\": 0,\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"ClusterName\\": \\"mse-74355150-xxxxxxx\\",\\n \\"InitStatus\\": \\"INIT_SUCCESS\\",\\n \\"InternetPort\\": \\"8848,6443,9848,8761\\",\\n \\"AppVersion\\": \\"2.1.0\\",\\n \\"NetType\\": \\"privatenet\\",\\n \\"ClusterVersion\\": \\"NACOS_2_0_0\\",\\n \\"ClusterSpecification\\": \\"MSE_SC_2_4_60_c\\",\\n \\"VSwitchId\\": \\"vsw-bp1egfakxxxxx\\",\\n \\"ConnectionType\\": \\"null\\",\\n \\"MseVersion\\": \\"mse_pro\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExpectZones\\": [\\n \\"cn-hangzhou-k\\"\\n ],\\n \\"MaintenancePeriod\\": {\\n \\"EndTime\\": \\"02:00\\",\\n \\"StartTime\\": \\"06:00\\"\\n },\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"SecurityGroupId\\": \\"sg-uf6hgwe067prhg68agfa\\",\\n \\"SecurityGroupType\\": \\"enterprise\\",\\n \\"EipInstanceId\\": \\"eip-bp1uujshd5funmyy8rcl9\\",\\n \\"CanUpdate\\": true,\\n \\"VersionCode\\": \\"NACOS_2_1_0_1\\",\\n \\"VersionLifecycle\\": \\"\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryClusterInfo', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"12\\"\\n}","type":"json"}]', - 'title' => 'AddSecurityGroupRule', + 'translator' => 'machine', ], - 'DeleteGateway' => [ - 'summary' => 'Deletes a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryClusterSpecification' => [ + 'summary' => 'Queries the information of supported instance specifications.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '24808', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], - ], + 'operationType' => 'read', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeleteSlb', + 'name' => 'ConnectType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.'."\n", - 'type' => 'boolean', + 'title' => '', + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* slb'."\n" + .'* eni'."\n", + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'example' => 'slb', + 'pattern' => '', + 'enum' => ['eni', 'slb'], ], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'MseVersion', 'in' => 'query', 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", + 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" + ."\n" + .'* mse_pro: Professional Edition'."\n" + .'* mse_dev: Developer Edition'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-0fe488252dc44d55a9dd57875193a1d7', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'mse_pro', + 'title' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The HTTP status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Code' => ['description' => 'The return value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], 'Data' => [ 'description' => 'The details of the data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the primary key.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The name of the gateway.'."\n", - 'type' => 'string', - 'example' => 'mse-bc1a29b0-reg-center-0-1', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway. The ID is automatically generated by the system.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PrimaryUser' => [ - 'description' => 'The information about the user.'."\n", - 'type' => 'string', - 'example' => '1231254', - ], - 'Status' => [ - 'description' => 'The status of the gateway. Valid values: 0: The gateway is being created. 1: The gateway fails to be created. 2: The gateway is running. 3: The gateway is changing. 4: The gateway is scaling down. 6: The gateway is scaling up. 8: The gateway is being deleted. 10: The gateway is restarting. 11: The gateway is being rebuilt. 12: The gateway is updating. 13: The gateway fails to be updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Vpc' => [ - 'description' => 'The ID of the virtual private cloud (VPC) where the gateway resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1328cm01m6uel42b5zb', - ], - 'Vswitch' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', - ], - 'SecurityGroup' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-bp11ufzqn6mmb8dtzz82', - ], - 'Spec' => [ - 'description' => 'The specifications of the gateway.'."\n", - 'type' => 'string', - 'example' => 'MSE_GTW_16_32_200_c', - ], - 'Replica' => [ - 'description' => 'The number of gateway replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The time when the gateway was last updated.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', + 'type' => 'array', + 'items' => [ + 'description' => 'The results that are returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterSpecificationName' => ['description' => 'The engine specifications that can be used.'."\n", 'type' => 'string', 'example' => 'MSE_SC_1_2_200_c', 'title' => ''], + 'MemoryCapacity' => ['description' => 'The memory size in the specifications. Unit: GB.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'CpuCapacity' => ['description' => 'The number of vCPUs in the specifications.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": [\\n {\\n \\"ClusterSpecificationName\\": \\"MSE_SC_1_2_200_c\\",\\n \\"MemoryCapacity\\": \\"2\\",\\n \\"CpuCapacity\\": \\"1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryClusterSpecification', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:QueryClusterSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"mse-bc1a29b0-reg-center-0-1\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"1231254\\",\\n \\"Status\\": 1,\\n \\"Vpc\\": \\"vpc-bp1328cm01m6uel42b5zb\\",\\n \\"Vswitch\\": \\"vsw-bp18zeqxx6mpuq843z4n5\\",\\n \\"SecurityGroup\\": \\"sg-bp11ufzqn6mmb8dtzz82\\",\\n \\"Spec\\": \\"MSE_GTW_16_32_200_c\\",\\n \\"Replica\\": 2,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteGateway', ], - 'DeleteGatewaySlb' => [ - 'summary' => 'Deletes the Server Load Balancer (SLB) instance that is associated with a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryConfig' => [ + 'summary' => 'Queries the configuration of a cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '71802', - 'abilityTreeNodes' => [ - 'FEATUREmseMNDRFM', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17081', + 'abilityTreeNodes' => ['FEATUREmseY3D6DK'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the association record.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '395', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'DeleteSlb', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ConfigType', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], + 'schema' => ['description' => 'A reserved field.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'SlbId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the SLB instance that needs to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lb-uf6duug6s13x4abc8****', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-st2212****', 'title' => ''], + ], + [ + 'name' => 'NeedRunningConf', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query the runtime configuration.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112EC53', 'title' => ''], 'Data' => [ - 'description' => 'The deletion result.'."\n", - 'type' => 'string', - 'example' => '28', + 'description' => 'The data overview.', + 'type' => 'object', + 'properties' => [ + 'MaxClientCnxns' => ['description' => 'The ZooKeeper configuration. This parameter indicates the number of connections between a client and a server.
'."\n" + .'If this parameter is set to 0, no limit is imposed.
', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ConfigAuthSupported' => ['description' => 'The Nacos configuration. This parameter indicates whether the configuration center of the current cluster supports RAM authentication. Valid values:'."\n" + ."\n" + .'- `true`: supported'."\n" + ."\n" + .'- `false`: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InitLimit' => ['description' => 'The ZooKeeper configuration. This parameter indicates the maximum connection duration of an instance. Unit: seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'MCPEnabled' => ['description' => 'The Nacos configuration. This parameter indicates whether Mesh Configuration Protocol (MCP) is enabled. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OpenSuperAcl' => ['description' => 'The ZooKeeper configuration. This parameter indicates whether the super permission is enabled. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RestartFlag' => ['description' => 'Indicates whether the cluster is restarted and the new configuration is applied. Valid values:'."\n" + ."\n" + .'- `true`: The cluster is restarted.'."\n" + ."\n" + .'- `false`: The cluster fails to be restarted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'JvmFlagsCustom' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => 'none', 'title' => ''], + 'AutopurgePurgeInterval' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => 'none', 'title' => ''], + 'AutopurgeSnapRetainCount' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => 'none', 'title' => ''], + 'SyncLimit' => ['description' => 'The ZooKeeper configuration. This parameter indicates the connection timeout duration of an instance. Unit: seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ConfigAuthEnabled' => ['description' => 'The Nacos configuration. This parameter indicates whether RAM authentication is enabled for the configuration center. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ClusterName' => ['description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'MCPSupported' => ['description' => 'The Nacos configuration. This parameter indicates whether MCP is supported. Valid values:'."\n" + ."\n" + .'- `true`: supported'."\n" + ."\n" + .'- `false`: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'JuteMaxbuffer' => ['description' => 'The ZooKeeper configuration. This parameter indicates the maximum data size of each node. Unit: bytes.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TickTime' => ['description' => 'The ZooKeeper configuration. This parameter indicates a unit of time in the engine. The default value is 2000. Unit: milliseconds.', 'type' => 'string', 'example' => '2000', 'title' => ''], + 'PassWord' => ['description' => 'The password. This parameter is returned only when OpenSuperAcl is set to true.', 'type' => 'string', 'example' => 'password', 'title' => ''], + 'UserName' => ['description' => 'The username. This parameter is returned only when OpenSuperAcl is set to true.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'ConfigSecretSupported' => ['description' => 'The Nacos configuration. This parameter indicates whether the cluster supports configuration encryption. Valid values:'."\n" + ."\n" + .'- `true`: supported'."\n" + ."\n" + .'- `false`: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ConfigSecretEnabled' => ['description' => 'The Nacos configuration. This parameter indicates whether configuration encryption is enabled for the cluster. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NamingAuthEnabled' => ['description' => 'The Nacos configuration. This parameter indicates whether RAM authentication is enabled for the service registry. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'NamingAuthSupported' => ['description' => 'The Nacos configuration. This parameter indicates whether the cluster supports RAM authentication for services. Valid values:'."\n" + ."\n" + .'- `true`: supported'."\n" + ."\n" + .'- `false`: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NamingCreateServiceSupported' => ['description' => 'The Nacos configuration. This parameter indicates whether the cluster supports service creation. Valid values:'."\n" + ."\n" + .'- `true`: supported'."\n" + ."\n" + .'- `false`: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MinSessionTimeout' => ['description' => 'The ZooKeeper configuration. This parameter indicates the minimum timeout duration.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'MaxSessionTimeout' => ['description' => 'The ZooKeeper configuration. This parameter indicates the maximum timeout duration.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'SnapshotCount' => ['description' => 'The ZooKeeper configuration. This parameter indicates the frequency of generating snapshots.', 'type' => 'string', 'example' => '100000', 'title' => ''], + 'ConfigContentLimit' => ['description' => 'The maximum size of the content of a single configuration. Unit: KB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'NacosRunningEnv' => [ + 'description' => 'The runtime configuration of Nacos.', + 'type' => 'object', + 'properties' => [ + 'emptyProtect' => ['description' => 'The switch for push-empty protection.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'grayAuth' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ExtendedTypesEnable' => ['description' => 'The ZooKeeper parameter that specifies whether to enable the TTL configuration.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EurekaSupported' => ['description' => 'Specifies whether to enable port 8761 for access to the Eureka protocol. If you disable this port, applications cannot use the Eureka protocol for service registration and discovery.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TLSEnabled' => ['description' => 'MSE Nacos instances of version 2.1.2.1 or later support Transport Layer Security (TLS) encryption. The version of the Nacos client must be 2.2.1 or later. After you enable TLS, the performance may decrease by about 10%. You must evaluate the system capacity. For more information about the operations, see Nacos TLS transport encryption.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ConsoleUIEnabled' => ['description' => 'Specifies whether to enable the Nacos open source console.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Enable4lw' => ['description' => 'Specifies whether to enable the four-letter words command.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AuthEnabled' => ['description' => 'The switch for ZooKeeper SASL-based forced identity authentication.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The result code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112EC53\\",\\n \\"Data\\": {\\n \\"MaxClientCnxns\\": \\"0\\",\\n \\"ConfigAuthSupported\\": true,\\n \\"InitLimit\\": \\"100\\",\\n \\"MCPEnabled\\": true,\\n \\"OpenSuperAcl\\": true,\\n \\"RestartFlag\\": true,\\n \\"JvmFlagsCustom\\": \\"none\\",\\n \\"AutopurgePurgeInterval\\": \\"none\\",\\n \\"AutopurgeSnapRetainCount\\": \\"none\\",\\n \\"SyncLimit\\": \\"10\\",\\n \\"ConfigAuthEnabled\\": true,\\n \\"ClusterName\\": \\"name\\",\\n \\"MCPSupported\\": true,\\n \\"JuteMaxbuffer\\": \\"1\\",\\n \\"TickTime\\": \\"2000\\",\\n \\"PassWord\\": \\"password\\",\\n \\"UserName\\": \\"name\\",\\n \\"ConfigSecretSupported\\": true,\\n \\"ConfigSecretEnabled\\": true,\\n \\"NamingAuthEnabled\\": false,\\n \\"NamingAuthSupported\\": true,\\n \\"NamingCreateServiceSupported\\": true,\\n \\"MinSessionTimeout\\": \\"-1\\",\\n \\"MaxSessionTimeout\\": \\"-1\\",\\n \\"SnapshotCount\\": \\"100000\\",\\n \\"ConfigContentLimit\\": 100,\\n \\"NacosRunningEnv\\": {\\n \\"emptyProtect\\": true,\\n \\"grayAuth\\": \\"\\"\\n },\\n \\"ExtendedTypesEnable\\": true,\\n \\"EurekaSupported\\": true,\\n \\"TLSEnabled\\": true,\\n \\"ConsoleUIEnabled\\": true,\\n \\"Enable4lw\\": true,\\n \\"AuthEnabled\\": true\\n },\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'QueryConfig', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9297B27D-D932-5E9F-93B9-99D6C5F3A879\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": \\"28\\"\\n}","type":"json"}]', - 'title' => 'DeleteGatewaySlb', + 'translator' => 'manual', ], - 'DeleteSecurityGroupRule' => [ - 'summary' => 'Deletes a security group rule from a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryGatewayRegion' => [ + 'summary' => 'Queries the regions supported by a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The destination ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '93', - ], - ], - [ - 'name' => 'CascadingDelete', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], - ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '43E50CB7-258E-5AFF-9B93-ECC19928C699', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-uf6hgwe067prhg68agfa', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'PortRange' => [ - 'description' => 'The range of ports for the transport layer protocol in the destination security group. Valid values:'."\n" - ."\n" - .'* When the IpProtocol parameter is set to tcp or udp, the port number range is 1 to 65535. The start port number and the end port number are separated by a forward slash (/). Example: 1/200.'."\n" - .'* If the IpProtocol parameter is set to icmp, the port number range is -1/-1, which indicates all ports.'."\n" - .'* If the IpProtocol parameter is set to gre, the port number range is -1/-1, which indicates all ports.'."\n" - .'* If the IpProtocol parameter is set to all, the port number range is -1/-1, which indicates all ports.'."\n", - 'type' => 'string', - 'example' => '8443/8443', - ], - 'IpProtocol' => [ - 'description' => 'The transport layer protocol. The value of this parameter is case-insensitive. Valid values:'."\n" - ."\n" - .'* icmp'."\n" - .'* gre'."\n" - .'* tcp'."\n" - .'* udp'."\n" - .'* all: All protocols are supported.'."\n", - 'type' => 'string', - 'example' => 'tcp', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-11T14:12:55.000+0000', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'auto-description1', - ], - ], + 'type' => 'array', + 'items' => ['description' => 'The information about regions.'."\n", 'type' => 'string', 'example' => '{"cn-hanghzou"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"{\\\\\\"cn-hanghzou\\\\\\"}\\"\\n ]\\n}","type":"json"}]', + 'title' => 'QueryGatewayRegion', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayRegion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43E50CB7-258E-5AFF-9B93-ECC19928C699\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 2,\\n \\"SecurityGroupId\\": \\"sg-uf6hgwe067prhg68agfa\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"PortRange\\": \\"8443/8443\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"GatewayId\\": 103,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-11T14:12:55.000+0000\\",\\n \\"Description\\": \\"auto-description1\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteSecurityGroupRule', ], - 'UpdateGatewayOption' => [ - 'summary' => 'Updates the configurations of a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryGatewayType' => [ + 'summary' => 'Queries available gateway types.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '421', - ], - ], - [ - 'name' => 'GatewayOption', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The detailed configurations of the gateway.'."\n" - ."\n" - .'* **TraceDetails**: the sampling description of Managed Service for OpenTelemetry. Content: TraceEnabled indicates whether Managed Service for OpenTelemetry is activated. Sample indicates the sampling rate of Managed Service for OpenTelemetry.'."\n" - .'* **LogConfigDetails**: the description of Simple Log Service. Content: LogEnabled indicates whether Simple Log Service is activated. ProjectName indicates the Simple Log Service project to which logs are delivered. LogStoreName indicates the name of the Logstore.'."\n" - .'* **EnableHardwareAcceleration**: indicates whether hardware acceleration is enabled.'."\n" - .'* **DisableHttp2Alpn**: indicates whether the HTTP/2 protocol is disabled.'."\n" - .'* **EnableWaf**: indicates whether Web Application Firewall (WAF) is enabled.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/GatewayOption', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c4****', - ], - ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '124D02EB-DBDD-534D-A701-B4A95D3D****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': True}, \'TraceDetails\': {\'Sample\': 17, \'TraceEnabled\': True}}', - '$ref' => '#/components/schemas/GatewayOption', + 'description' => 'The information about the gateway type. The data type of this parameter is List.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The type of the gateway.'."\n", 'type' => 'string', 'example' => 'Ingress', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"Ingress\\"\\n ]\\n}","type":"json"}]', + 'title' => 'QueryGatewayType', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"124D02EB-DBDD-534D-A701-B4A95D3D****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TraceDetails\\": {\\n \\"TraceEnabled\\": true,\\n \\"Sample\\": 0,\\n \\"TraceType\\": \\"XTRACE\\",\\n \\"ServiceId\\": 0,\\n \\"ServicePort\\": \\"\\"\\n },\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"\\",\\n \\"LogStoreName\\": \\"\\"\\n },\\n \\"EnableHardwareAcceleration\\": true,\\n \\"DisableHttp2Alpn\\": true,\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', - 'title' => 'UpdateGatewayOption', ], - 'UpdateGatewayName' => [ - 'summary' => 'Updates the name of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryGovernanceKubernetesCluster' => [ + 'summary' => 'Queries Kubernetes clusters for microservice administration.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '66628', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '116299', + 'abilityTreeNodes' => ['FEATUREmse3O985H'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'demo-test', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The name of the Kubernetes cluster.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-cluster', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-1cef54brvecdb419fb264d4f9b8c', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The ID of the Kubernetes cluster.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c24c9354acxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of items per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '5', 'example' => '10', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- `zh`: Chinese'."\n" + ."\n" + .'- `en`: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8C95711F-E702-5395-BFAA-21BA946CDE47', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE34D413-2B79-5E77-9696-36D875E822AD', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => 'true', + 'description' => 'The data returned in the response.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'A list of cluster objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a cluster.', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'title' => '', 'example' => 'example-cluster'], + 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'abcdef123456789'], + 'Region' => ['description' => 'The region where the cluster is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], + 'K8sVersion' => ['description' => 'The Kubernetes version.', 'type' => 'string', 'title' => '', 'example' => '1.22'], + 'NamespaceInfos' => ['description' => 'A JSON string that contains an array of namespace objects.', 'type' => 'string', 'title' => '', 'example' => '[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]'], + 'PilotStartTime' => ['description' => 'The time when Pilot started, in UTC (ISO 8601 format).', 'type' => 'string', 'title' => '', 'example' => '2022-05-17T05:39:43.000+0000'], + 'VersionLifeCycle' => ['description' => 'The lifecycle status of the version.', 'type' => 'string', 'title' => '', 'example' => ''], + 'PilotVersion' => ['description' => 'The Pilot version.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalSize' => ['description' => 'The total number of clusters that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DE34D413-2B79-5E77-9696-36D875E822AD\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"ClusterName\\": \\"example-cluster\\",\\n \\"ClusterId\\": \\"abcdef123456789\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"K8sVersion\\": \\"1.22\\",\\n \\"NamespaceInfos\\": \\"[{\\\\\\"Name\\\\\\":\\\\\\"ack-onepilot\\\\\\",\\\\\\"Tags\\\\\\":{\\\\\\"name\\\\\\":\\\\\\"ack-onepilot\\\\\\"}}]\\",\\n \\"PilotStartTime\\": \\"2022-05-17T05:39:43.000+0000\\",\\n \\"VersionLifeCycle\\": \\"\\",\\n \\"PilotVersion\\": \\"\\"\\n }\\n ],\\n \\"TotalSize\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryGovernanceKubernetesCluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C95711F-E702-5395-BFAA-21BA946CDE47\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'UpdateGatewayName', ], - 'QueryGatewayRegion' => [ - 'summary' => 'Queries the regions supported by a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryInstancesInfo' => [ + 'summary' => 'Queries the runtime data of a specified cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -40862,123 +27845,128 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '129092', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl32g1u9k01', 'title' => ''], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'required' => false, 'example' => '20574710974****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'BaseResult', + 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message that is returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The details of the data.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about regions.'."\n", - 'type' => 'string', - 'example' => '{"cn-hanghzou"}', + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'HealthStatus' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Role' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'PodName' => ['description' => 'The pod name.'."\n", 'type' => 'string', 'example' => 'mse-xxxxx-xxxxx-reg-center-0-1', 'title' => ''], + 'Ip' => ['description' => 'The IP address of the pod.'."\n", 'type' => 'string', 'example' => '25.24.91.x', 'title' => ''], + 'InternetIp' => ['description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => '120.55.71.x', 'title' => ''], + 'SingleTunnelVip' => ['description' => 'The internal IP address.'."\n", 'type' => 'string', 'example' => '172.16.66.x', 'title' => ''], + 'CreationTimestamp' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-12-15T02:02:15Z', 'title' => ''], + 'ClientPort' => ['description' => 'The enabled port.'."\n", 'type' => 'string', 'example' => '8848', 'title' => ''], + 'Zone' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], + 'ZoneDistributed' => ['description' => 'Indicates whether all pods in the cluster are distributed in the specified zones.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"Data\\": [\\n {\\n \\"HealthStatus\\": \\"null\\",\\n \\"Role\\": \\"null\\",\\n \\"PodName\\": \\"mse-xxxxx-xxxxx-reg-center-0-1\\",\\n \\"Ip\\": \\"25.24.91.x\\",\\n \\"InternetIp\\": \\"120.55.71.x\\",\\n \\"SingleTunnelVip\\": \\"172.16.66.x\\",\\n \\"CreationTimestamp\\": \\"2022-12-15T02:02:15Z\\",\\n \\"ClientPort\\": \\"8848\\",\\n \\"Zone\\": \\"cn-hangzhou-k\\",\\n \\"ZoneDistributed\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryInstancesInfo', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryInstancesInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"{\\\\\\"cn-hanghzou\\\\\\"}\\"\\n ]\\n}","type":"json"}]', - 'title' => 'QueryGatewayRegion', ], - 'QueryGatewayType' => [ - 'summary' => 'Queries available gateway types.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryMonitor' => [ + 'summary' => 'Queries monitoring information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -40988,124 +27976,353 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '17082', + 'abilityTreeNodes' => ['FEATUREmseZAXYAZ'], ], 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'MonitorType', + 'in' => 'query', + 'schema' => ['description' => 'The metric type. The following metric types are supported:'."\n" + ."\n" + .'\\[Basic system metrics]'."\n" + ."\n" + .'* cpuUsage'."\n" + .'* memoryUsage'."\n" + .'* diskUsage'."\n" + .'* gcCount'."\n" + .'* gcTime'."\n" + ."\n" + .'\\[Nacos registry]'."\n" + ."\n" + .'* serviceCount'."\n" + .'* writeCostTime'."\n" + .'* readCostTime'."\n" + .'* TPS regCenterTps'."\n" + .'* QPS regCenterQps'."\n" + ."\n" + .'\\[Nacos configuration center]'."\n" + ."\n" + .'* publish'."\n" + .'* getConfig'."\n" + ."\n" + .'\\[zookeeper]'."\n" + ."\n" + .'* TPS zk_TpsCount'."\n" + .'* QPS zk_QpsCount'."\n" + .'* zookeeper_AvgRequestLatency'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'regCenterQps', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the monitoring starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1666678376', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the monitoring ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1666678376', 'title' => ''], + ], + [ + 'name' => 'Step', + 'in' => 'query', + 'schema' => ['description' => 'The interval between data points. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-****', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', 'title' => ''], 'Data' => [ - 'description' => 'The information about the gateway type. The data type of this parameter is List.'."\n", + 'description' => 'The details of the data.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The type of the gateway.'."\n", - 'type' => 'string', - 'example' => 'Ingress', + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'podName' => ['description' => 'The name of the pod.'."\n", 'type' => 'string', 'example' => 'mse-xxxxxx-xxxxxx-reg-center-0-0', 'title' => ''], + 'clusterNamePrefix' => ['description' => 'The prefix of the name.'."\n", 'type' => 'string', 'example' => 'mse-xxxx-xxxxxx', 'title' => ''], + 'values' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The content of the data.'."\n", 'type' => 'object', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'example' => '6', + 'title' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": [\\n {\\n \\"podName\\": \\"mse-xxxxxx-xxxxxx-reg-center-0-0\\",\\n \\"clusterNamePrefix\\": \\"mse-xxxx-xxxxxx\\",\\n \\"values\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryMonitor', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryNamespace' => [ + 'summary' => 'Queries the namespace to which Microservices Governance belongs.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The region to which the namespace belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace that you want to query.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], + ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'title' => '', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcde-fg', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'title' => '', + 'description' => 'The data that is returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region to which the namespace belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"abcde-fg\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryNamespace', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"Ingress\\"\\n ]\\n}","type":"json"}]', - 'title' => 'QueryGatewayType', + 'translator' => 'manual', ], - 'GetGateway' => [ - 'summary' => 'Obtains the basic information about a gateway, such as the virtual private cloud (VPC) and vSwitch to which the gateway belongs.', - 'methods' => [ - 'get', - 'post', + 'QuerySlbSpec' => [ + 'summary' => 'Queries the type of a Server Load Balancer (SLB) instance.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The return value.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data entries returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the SLB instance.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Spec' => ['description' => 'The specification of the instance.', 'type' => 'string', 'example' => 'slb.s2.small', 'title' => ''], + 'Name' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'Standard I', 'title' => ''], + 'MaxConnection' => ['description' => 'The maximum number of connections.', 'type' => 'string', 'example' => '50,000', 'title' => ''], + 'NewConnectionPerSecond' => ['description' => 'The number of connections per second.', 'type' => 'string', 'example' => '50,000', 'title' => ''], + 'Qps' => ['description' => 'The number of queries per second (QPS).', 'type' => 'string', 'example' => '50,000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], ], - 'tags' => [ - 'gateway', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 2,\\n \\"Spec\\": \\"slb.s2.small\\",\\n \\"Name\\": \\"Standard I\\",\\n \\"MaxConnection\\": \\"50,000\\",\\n \\"NewConnectionPerSecond\\": \\"50,000\\",\\n \\"Qps\\": \\"50,000\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QuerySlbSpec', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:QuerySlbSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QuerySwimmingLaneById' => [ + 'summary' => 'Queries swimming lane information by swimming lane ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -41115,353 +28332,163 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '92862', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'abilityTreeCode' => '116123', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'LaneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-685f661467b54f48b7b7a76605ce****', - ], + 'schema' => ['description' => 'The swimming lane ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '250', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'The name of the MSE namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], 'Data' => [ - 'description' => 'The information about the gateway.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The name of the gateway.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PrimaryUser' => [ - 'description' => 'The Alibaba Cloud account ID of the user who created the gateway.'."\n", - 'type' => 'string', - 'example' => '1231254', - ], - 'Status' => [ - 'description' => 'The status of the gateway. Valid values:'."\n" - ."\n" - .'* 0: The gateway is being created.'."\n" - .'* 1: The gateway fails to be created.'."\n" - .'* 2: The gateway is running.'."\n" - .'* 3: The gateway is changing.'."\n" - .'* 4: The gateway is scaling in.'."\n" - .'* 6: The gateway is scaling out.'."\n" - .'* 8: The gateway is being deleted.'."\n" - .'* 10: The gateway is restarting.'."\n" - .'* 11: The gateway is being rebuilt.'."\n" - .'* 12: The gateway is updating.'."\n" - .'* 13: The gateway fails to be updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Vpc' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1328cm01m6uel42b5zb', - ], - 'Vswitch' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', - ], - 'SecurityGroup' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-bp11ufzqn6mmb8dtzz82', - ], - 'Spec' => [ - 'description' => 'The specifications of the gateway.'."\n", - 'type' => 'string', - 'example' => 'MSE_GTW_16_32_200_c', - ], - 'Replica' => [ - 'description' => 'The number of gateway replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => 'The time when the gateway was created. The time is displayed in GMT. The time is the local time of the region in which the gateway resides.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The time when the gateway was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'XtraceDetails' => [ - 'description' => 'The details of Tracing Analysis.'."\n", - 'type' => 'object', - 'properties' => [ - 'Sample' => [ - 'description' => 'The sampling rate of Tracing Analysis.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TraceOn' => [ - 'description' => 'Indicates whether sampling by using Tracing Analysis is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Vswitch2' => [ - 'description' => 'The ID of the secondary vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1j6ivhav15ve7q54kq2', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ChargeType' => [ - 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'EndDate' => [ - 'description' => 'The time when the gateway expires.'."\n", - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'StatusDesc' => [ - 'description' => 'The description of the status.'."\n", - 'type' => 'string', - 'example' => 'Restarting'."\n", - ], - 'LogConfigDetails' => [ - 'description' => 'The log configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'LogEnabled' => [ - 'description' => 'Indicates whether Log Service is activated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ProjectName' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'example' => 'k8s-log-c173117256e934a96b7fefdf2ef8a8057', - ], - 'LogStoreName' => [ - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'example' => 'mse_access_log', - ], - ], - ], - 'MseTag' => [ - 'description' => 'The tag of the resource.'."\n", - 'type' => 'string', - 'example' => '{"TagKey":"TagValue"}', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfm34x43l*****', - ], - 'TotalReplica' => [ - 'description' => 'The total number of replicas, including the number of replicas that are automatically scaled out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Elastic' => [ - 'description' => 'Indicates whether auto scale-out is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ElasticReplica' => [ - 'description' => 'The number of replicas that are automatically scaled out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ElasticType' => [ - 'description' => 'The type of auto scale-out. Valid value:'."\n" - ."\n" - .'* CronHPA: scale-out by time'."\n", - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'ElasticPolicy' => [ - 'description' => 'The auto scale-out policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'MaxReplica' => [ - 'description' => 'The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'ElasticType' => [ - 'description' => 'The type of auto scale-out. Valid value:'."\n" - ."\n" - .'* CronHPA: scale-out by time'."\n", - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'TimePolicyList' => [ - 'description' => 'The policy of scale-out by time.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DesiredReplica' => [ - 'description' => 'The number of expected replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'StartTime' => [ - 'description' => 'The start time of auto scale-out.'."\n", - 'type' => 'string', - 'example' => '16:00', - ], - 'EndTime' => [ - 'description' => 'The end time of auto scale-out.'."\n", - 'type' => 'string', - 'example' => '18:00', + 'name' => ['description' => 'The swimming lane name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'id' => ['description' => 'The swimming lane ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'tag' => ['description' => 'The tag corresponding to the swimming lane.', 'type' => 'string', 'example' => 'gray', 'title' => ''], + 'status' => ['description' => 'The swimming lane status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'enable' => ['description' => 'The swimming lane switch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'groupId' => ['description' => 'The swimming lane group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'entryRule' => ['description' => 'The entry application rule.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'entryRules' => [ + 'description' => 'The details of the entry application rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The entry application rule.', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => 'The list of paths.', + 'type' => 'array', + 'items' => ['description' => 'The path.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'path' => ['description' => 'The path.', 'type' => 'string', 'title' => '', 'example' => '/'], + 'condition' => ['description' => 'The condition.', 'type' => 'string', 'example' => 'AND', 'title' => ''], + 'restItems' => [ + 'description' => 'The Restful matching rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Restful matching rule.', + 'type' => 'object', + 'properties' => [ + 'type' => ['title' => '匹配类型', 'description' => 'The matching type.', 'type' => 'string', 'example' => 'cookie'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'example' => '11111'], + 'operator' => ['title' => '操作符', 'description' => 'The filter operator.', 'type' => 'string', 'example' => 'rawvalue'], + 'nameList' => [ + 'title' => '匹配列表', + 'description' => 'The names.', + 'type' => 'array', + 'items' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'maxItems' => 10, + 'example' => '', + ], + 'datum' => ['title' => '数值', 'description' => 'The number.', 'type' => 'string', 'example' => 'x'], + 'cond' => ['title' => '匹配符', 'description' => 'The matching character.', 'type' => 'string', 'example' => '=='], + 'divisor' => ['title' => '除数', 'description' => 'The divisor.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'remainder' => ['title' => '余数', 'description' => 'The remainder.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'rate' => ['title' => '百分比', 'description' => 'The percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'value' => ['title' => '值', 'description' => 'The value.', 'type' => 'string', 'example' => 'hello'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'enableRules' => ['description' => 'Specifies whether to enable the rule. Valid values:', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'gmtCreate' => ['description' => 'Rule Created At', 'type' => 'string', 'example' => '1683598484000', 'title' => ''], + 'gmtModified' => ['description' => 'Rule Modified At', 'type' => 'string', 'example' => '1683598484000', 'title' => ''], + 'gatewaySwimmingLaneRouteJson' => ['description' => 'The MSE gateway routing rule.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'PathIndependentPercentageEnable' => ['description' => 'This parameter is discontinued. This parameter is used to specify whether to enable grayscale by path when Java gateway is used as the entry for the swimming lane group.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'example' => '{id:102,name:"test"}', + 'title' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": {\\n \\"name\\": \\"test\\",\\n \\"id\\": 1,\\n \\"tag\\": \\"gray\\",\\n \\"status\\": 1,\\n \\"enable\\": true,\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"groupId\\": 8,\\n \\"entryRule\\": \\"{}\\",\\n \\"entryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"11111\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"hello\\"\\n }\\n ]\\n }\\n ],\\n \\"enableRules\\": true,\\n \\"gmtCreate\\": \\"1683598484000\\",\\n \\"gmtModified\\": \\"1683598484000\\",\\n \\"gatewaySwimmingLaneRouteJson\\": \\"{}\\",\\n \\"PathIndependentPercentageEnable\\": false\\n }\\n}","type":"json"}]', + 'title' => 'QuerySwimmingLaneById', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QuerySwimmingLaneById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"DEFAULT\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"1231254\\",\\n \\"Status\\": 0,\\n \\"Vpc\\": \\"vpc-bp1328cm01m6uel42b5zb\\",\\n \\"Vswitch\\": \\"vsw-bp18zeqxx6mpuq843z4n5\\",\\n \\"SecurityGroup\\": \\"sg-bp11ufzqn6mmb8dtzz82\\",\\n \\"Spec\\": \\"MSE_GTW_16_32_200_c\\",\\n \\"Replica\\": 1,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"XtraceDetails\\": {\\n \\"Sample\\": 10,\\n \\"TraceOn\\": true\\n },\\n \\"Vswitch2\\": \\"vpc-bp1j6ivhav15ve7q54kq2\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"StatusDesc\\": \\"正在重启中。\\",\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"k8s-log-c173117256e934a96b7fefdf2ef8a8057\\",\\n \\"LogStoreName\\": \\"mse_access_log\\"\\n },\\n \\"MseTag\\": \\"{\\\\\\"TagKey\\\\\\":\\\\\\"TagValue\\\\\\"}\\",\\n \\"ResourceGroupId\\": \\"rg-acfm34x43l*****\\",\\n \\"TotalReplica\\": 3,\\n \\"Elastic\\": true,\\n \\"ElasticReplica\\": 1,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"ElasticPolicy\\": {\\n \\"MaxReplica\\": 5,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"TimePolicyList\\": [\\n {\\n \\"DesiredReplica\\": 2,\\n \\"StartTime\\": \\"16:00\\",\\n \\"EndTime\\": \\"18:00\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetGateway', ], - 'ListGateway' => [ - 'summary' => 'Queries a list of gateways.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryZnodeDetail' => [ + 'summary' => 'Queries the information about a ZooKeeper node.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -41471,1467 +28498,561 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '24675', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'abilityTreeCode' => '17085', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ - 'name' => 'OrderItem', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The order information.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper', 'title' => ''], ], [ - 'name' => 'DescSort', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the sorting feature. This feature is not available.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-5bffa4e8630', 'title' => ''], ], [ - 'name' => 'FilterParams', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The details of parameters.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'GatewayType' => [ - 'description' => 'The type of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Ingress', - ], - 'Name' => [ - 'description' => 'The name of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rutain-test', - ], - 'Vpc' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp13hhyjntbab7w****', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse_ingresspre-cn-****', - ], - 'MseTag' => [ - 'description' => 'The tag of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"key":"tagkey","value":"tagvalue"}]', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-7y2uye*****', + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'Path' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'example' => '/zookeeper', 'title' => ''], + 'Dir' => ['description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'zookeeper', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper the operation times out, it may be because the current Znode data is too large, there are too many child nodes, the server takes too long to process the request, or the cluster is currently selecting a host and cannot process the request.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => 'The currently operating node does not exist and may have been deleted.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => 'No permission to operate the current node.'], + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => 'The current ZooKeeper operation is invalid, please recheck and perform the operation.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => 'The current node already exists. Please check and try again.'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Data\\": {\\n \\"Data\\": \\"cluster\\",\\n \\"Path\\": \\"/zookeeper\\",\\n \\"Dir\\": true,\\n \\"Name\\": \\"zookeeper\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryZnodeDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryZnodeDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'RemoveApplication' => [ + 'summary' => 'Deletes a single application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17086', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The region of the gateway.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The microservice namespace.', 'type' => 'string', 'example' => 'prod', 'maxLength' => 64, 'title' => '', 'required' => false], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-app', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'abcde@12345', 'title' => ''], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34300B3-52EC-5049-8C96-914098CF****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*', - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '153', - ], - 'Name' => [ - 'description' => 'The gateway name.'."\n", - 'type' => 'string', - 'example' => 'tesa-test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14cebb8ce5cb6a4****', - ], - 'GatewayType' => [ - 'description' => 'The gateway type.'."\n", - 'type' => 'string', - 'example' => 'Ingress', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PrimaryUser' => [ - 'description' => 'The user information.'."\n", - 'type' => 'string', - 'example' => '18278117654342', - ], - 'Status' => [ - 'description' => 'The gateway state. Valid values:'."\n" - ."\n" - .'* 0: The gateway is being created.'."\n" - .'* 1: The gateway failed to be created.'."\n" - .'* 2: The gateway is running.'."\n" - .'* 3: The gateway is being changed.'."\n" - .'* 4: The gateway is scaling in.'."\n" - .'* 6: The gateway is scaling out.'."\n" - .'* 8: The gateway is being deleted.'."\n" - .'* 9: The gateway is suspended and is to be released.'."\n" - .'* 10: The gateway is restarting.'."\n" - .'* 11: The gateway is being rebuilt.'."\n" - .'* 12: The gateway is being upgraded.'."\n" - .'* 13: The gateway failed to be upgraded.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AhasOn' => [ - 'description' => 'Indicates whether Application High Availability Service (AHAS) is activated.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ArmsOn' => [ - 'description' => 'Indicates whether Application Real-Time Monitoring Service (ARMS) is activated.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Spec' => [ - 'description' => 'The specifications of the gateway.'."\n", - 'type' => 'string', - 'example' => 'MSE_GTW_1_2_200_c', - ], - 'Replica' => [ - 'description' => 'The number of replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => 'The time when the gateway was created.'."\n", - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'GmtModified' => [ - 'description' => 'The time when the gateway was modified.'."\n", - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'StatusDesc' => [ - 'description' => 'The description of the gateway state.'."\n", - 'type' => 'string', - 'example' => 'Restarting'."\n", - ], - 'Slb' => [ - 'description' => 'The details of Server Load Balancer (SLB) instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the SLB instances.'."\n", - 'type' => 'object', - 'properties' => [ - 'SlbIp' => [ - 'description' => 'The IP address of the SLB instance.'."\n", - 'type' => 'string', - 'example' => '153.12.XX.XX', - ], - 'SlbPort' => [ - 'description' => 'The port number of the SLB instance.'."\n", - 'type' => 'string', - 'example' => '80', - ], - 'SlbSpec' => [ - 'description' => 'The specifications of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'Type' => [ - 'description' => 'The network type. Valid values:'."\n" - ."\n" - .'* PUB_NET'."\n" - .'* PRIVATE_NET'."\n", - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'GatewaySlbStatus' => [ - 'description' => 'The state of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'Ready', - ], - 'StatusDesc' => [ - 'description' => 'The description of the state.'."\n", - 'type' => 'string', - 'example' => 'Creating'."\n", - ], - 'GatewaySlbMode' => [ - 'description' => 'The mode of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'UserHost', - ], - 'SlbId' => [ - 'description' => 'The ID of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'lb-bp1ut8asdfgucjk****', - ], - ], - ], - ], - 'InternetSlb' => [ - 'description' => 'The details of the Internet-facing SLB instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'SlbIp' => [ - 'description' => 'The IP address of the SLB instance.'."\n", - 'type' => 'string', - 'example' => '153.12.XX.XX', - ], - 'SlbPort' => [ - 'description' => 'The port number of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'SlbSpec' => [ - 'description' => 'The specifications of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'Type' => [ - 'description' => 'The type of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'InternetNetworkFlow' => [ - 'description' => 'The traffic of the gateway.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'GatewaySlbStatus' => [ - 'description' => 'The state of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'Ready', - ], - 'StatusDesc' => [ - 'description' => 'The description of the state.'."\n", - 'type' => 'string', - 'example' => 'Creating'."\n", - ], - 'GatewaySlbMode' => [ - 'description' => 'The mode of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'UserHost', - ], - 'SlbId' => [ - 'description' => 'The ID of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'lb-bp1ut8asdfgucjk****', - ], - ], - ], - ], - 'Upgrade' => [ - 'description' => 'Indicates whether the instance was upgraded.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'MustUpgrade' => [ - 'description' => 'Indicates whether the instance was forcefully upgraded.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SupportWasm' => [ - 'description' => 'Indicates whether WebAssembly (Wasm) is supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CurrentVersion' => [ - 'description' => 'The current version of the gateway.'."\n", - 'type' => 'string', - 'example' => '0.1.0-mse-gw', - ], - 'AppVersion' => [ - 'description' => 'The version of the application.'."\n", - 'type' => 'string', - 'example' => '1.0.1.0', - ], - 'LatestVersion' => [ - 'description' => 'The latest version of the gateway.'."\n", - 'type' => 'string', - 'example' => '0.1.0-mse-gw', - ], - 'Vswitch2' => [ - 'description' => 'The ID of the secondary vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bpbrveck45nf****', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'mse_ingresspost-cn-0jbvrcex****', - ], - 'ChargeType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'EndDate' => [ - 'description' => 'The time when the instance expires.'."\n", - 'type' => 'string', - 'example' => '4792060800000', - ], - 'Tag' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'InitConfig' => [ - 'description' => 'The configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableWaf' => [ - 'description' => 'Indicates whether Web Application Firewall (WAF) is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SupportWaf' => [ - 'description' => 'Indicates whether WAF is supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'GatewayVersion' => [ - 'description' => 'The version of the gateway.'."\n", - 'type' => 'string', - 'example' => '1.2.9', - ], - 'RollBack' => [ - 'description' => 'Indicates whether rollbacks are allowed.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'MseTag' => [ - 'description' => 'The resource tag.'."\n", - 'type' => 'string', - 'example' => '{"tagKey":"tagValue"}', - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-97hg87vi****', - ], - 'TotalReplica' => [ - 'description' => 'The total number of replicas, including the number of replicas that are automatically scaled out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Elastic' => [ - 'description' => 'Indicates whether auto scale-out is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ElasticReplica' => [ - 'description' => 'The number of replicas that are automatically scaled out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ElasticType' => [ - 'description' => 'The type of auto scale-out. Valid value:'."\n" - ."\n" - .'* CronHPA: scale-out by time'."\n", - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'ElasticPolicy' => [ - 'description' => 'The auto scale-out policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Elastic' => [ - 'description' => 'Indicates whether auto scale-out is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MaxReplica' => [ - 'description' => 'The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ElasticType' => [ - 'description' => 'The type of auto scale-out. Valid value:'."\n" - ."\n" - .'* CronHPA: scale-out by time'."\n", - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'TimePolicyList' => [ - 'description' => 'The time policy list for auto scale-out.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DesiredReplica' => [ - 'description' => 'The expected number of replicas for auto scale-out.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'StartTime' => [ - 'description' => 'The start time of auto scale-out.'."\n", - 'type' => 'string', - 'example' => '07:00', - ], - 'EndTime' => [ - 'description' => 'The end time of auto scale-out.'."\n", - 'type' => 'string', - 'example' => '09:00', - ], - ], - ], - ], - 'LoadWarningThreshold' => [ - 'title' => '网关按负载弹性的水位设置，true表示开启警戒水位，false表示开启安全水位', - 'type' => 'boolean', - ], - 'EnableScaleTimePolicyList' => [ - 'title' => '允许缩容时间段', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'ElasticInstanceId' => [ - 'description' => 'The ID of the elastic gateway. This parameter is returned if auto scale-out is used.'."\n", - 'type' => 'string', - 'example' => 'mse_ingresselastic_public_cn-uqm3d0*****', - ], - 'VpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC) to which the gateway belongs.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6heojei217tv14*****', - ], - 'MseVersion' => [ - 'type' => 'string', - ], - 'MaintenancePeriod' => [ - 'type' => 'object', - 'properties' => [ - 'TimeZone' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - ], - ], - 'GatewayEntry' => [ - 'title' => '网关入口地址（适用普通实例专业版）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NetType' => [ - 'title' => '入口网络类型'."\n" - ."\n" - .'- PRIVATE_NET：私网'."\n" - ."\n" - .'- PUB_NET：公网', - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'EntryDomain' => [ - 'title' => '入口域名', - 'type' => 'string', - 'example' => 'gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com', - ], - 'IpList' => [ - 'title' => '入口IP列表', - 'type' => 'array', - 'items' => [ - 'title' => '入口IP', - 'type' => 'string', - 'example' => '1.2.3.4', - ], - ], - 'HttpPorts' => [ - 'title' => 'HTTP监听端口列表', - 'type' => 'array', - 'items' => [ - 'title' => 'HTTP监听端口', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - ], - 'HttpsPorts' => [ - 'title' => 'HTTPS监听端口列表', - 'type' => 'array', - 'items' => [ - 'title' => 'HTTPS监听端口', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - ], - 'Status' => [ - 'title' => '网关入口就绪状态', - 'type' => 'string', - 'example' => 'Ready', - 'enum' => [ - 'Ready', - 'NotReady', - ], - ], - 'Ipv6List' => [ - 'title' => 'ipv6地址', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcde-12345', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The execution result.', 'type' => 'string', 'title' => '', 'example' => 'success'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcde-12345\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'RemoveApplication', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34300B3-52EC-5049-8C96-914098CF****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 153,\\n \\"Name\\": \\"tesa-test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebb8ce5cb6a4****\\",\\n \\"GatewayType\\": \\"Ingress\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"18278117654342\\",\\n \\"Status\\": 2,\\n \\"AhasOn\\": false,\\n \\"ArmsOn\\": false,\\n \\"Spec\\": \\"MSE_GTW_1_2_200_c\\",\\n \\"Replica\\": 2,\\n \\"GmtCreate\\": \\"2021-09-13 19:24:23\\",\\n \\"GmtModified\\": \\"2021-09-13 19:24:23\\",\\n \\"StatusDesc\\": \\"重启中\\",\\n \\"Slb\\": [\\n {\\n \\"SlbIp\\": \\"153.12.XX.XX\\",\\n \\"SlbPort\\": \\"80\\",\\n \\"SlbSpec\\": \\"slb.s2.small\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"创建中\\",\\n \\"GatewaySlbMode\\": \\"UserHost\\",\\n \\"SlbId\\": \\"lb-bp1ut8asdfgucjk****\\"\\n }\\n ],\\n \\"InternetSlb\\": [\\n {\\n \\"SlbIp\\": \\"153.12.XX.XX\\",\\n \\"SlbPort\\": \\"slb.s2.small\\",\\n \\"SlbSpec\\": \\"slb.s2.small\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"InternetNetworkFlow\\": \\"20\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"创建中\\",\\n \\"GatewaySlbMode\\": \\"UserHost\\",\\n \\"SlbId\\": \\"lb-bp1ut8asdfgucjk****\\"\\n }\\n ],\\n \\"Upgrade\\": false,\\n \\"MustUpgrade\\": false,\\n \\"SupportWasm\\": true,\\n \\"CurrentVersion\\": \\"0.1.0-mse-gw\\",\\n \\"AppVersion\\": \\"1.0.1.0\\",\\n \\"LatestVersion\\": \\"0.1.0-mse-gw\\",\\n \\"Vswitch2\\": \\"vsw-bpbrveck45nf****\\",\\n \\"InstanceId\\": \\"mse_ingresspost-cn-0jbvrcex****\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"EndDate\\": \\"4792060800000\\",\\n \\"Tag\\": \\"test\\",\\n \\"InitConfig\\": {\\n \\"EnableWaf\\": true,\\n \\"SupportWaf\\": true\\n },\\n \\"GatewayVersion\\": \\"1.2.9\\",\\n \\"RollBack\\": false,\\n \\"MseTag\\": \\"{\\\\\\"tagKey\\\\\\":\\\\\\"tagValue\\\\\\"}\\",\\n \\"ResourceGroupId\\": \\"rg-97hg87vi****\\",\\n \\"TotalReplica\\": 4,\\n \\"Elastic\\": true,\\n \\"ElasticReplica\\": 2,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"ElasticPolicy\\": {\\n \\"Elastic\\": true,\\n \\"MaxReplica\\": 10,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"TimePolicyList\\": [\\n {\\n \\"DesiredReplica\\": 4,\\n \\"StartTime\\": \\"07:00\\",\\n \\"EndTime\\": \\"09:00\\"\\n }\\n ],\\n \\"LoadWarningThreshold\\": true,\\n \\"EnableScaleTimePolicyList\\": [\\n {\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n }\\n ]\\n },\\n \\"ElasticInstanceId\\": \\"mse_ingresselastic_public_cn-uqm3d0*****\\",\\n \\"VpcId\\": \\"vpc-uf6heojei217tv14*****\\",\\n \\"MseVersion\\": \\"\\",\\n \\"MaintenancePeriod\\": {\\n \\"TimeZone\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n },\\n \\"GatewayEntry\\": [\\n {\\n \\"NetType\\": \\"PUB_NET\\",\\n \\"EntryDomain\\": \\"gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com\\",\\n \\"IpList\\": [\\n \\"1.2.3.4\\"\\n ],\\n \\"HttpPorts\\": [\\n 80\\n ],\\n \\"HttpsPorts\\": [\\n 443\\n ],\\n \\"Status\\": \\"Ready\\",\\n \\"Ipv6List\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"VersionLifecycle\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGateway', ], - 'ListGatewaySlb' => [ - 'summary' => 'Queries the Server Load Balancer (SLB) instances that are associated with a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'RemoveAuthPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '17087', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', - ], + 'schema' => ['description' => 'Policy ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '259', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Values: zh-CN (default): Chinese, en-US: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EAB345F4-3AC3-560C-B653-65717703****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'string', - 'example' => 'ID', - ], - 'SlbId' => [ - 'description' => 'The ID of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'lb-bp1kmnli3hdpreptw2ah3', - ], - 'SlbIp' => [ - 'description' => 'The IP address of the SLB instance.'."\n", - 'type' => 'string', - 'example' => '121.199.XX.XX', - ], - 'SlbPort' => [ - 'description' => 'The port number of the SLB instance.'."\n", - 'type' => 'string', - 'example' => '80,443', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-14 14:39:16', - ], - 'GatewaySlbMode' => [ - 'description' => 'The mode of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'UserSelect', - ], - 'GatewaySlbStatus' => [ - 'description' => 'The association status.'."\n", - 'type' => 'string', - 'example' => 'Ready', - ], - 'StatusDesc' => [ - 'description' => 'The description of the status.'."\n", - 'type' => 'string', - 'example' => 'Associating'."\n", - ], - 'VServerGroupId' => [ - 'description' => 'The ID of the HTTP virtual service group.'."\n", - 'type' => 'string', - 'example' => '353', - ], - 'HttpPort' => [ - 'description' => 'The port number of the HTTP virtual service group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'HttpsPort' => [ - 'description' => 'The port number of the HTTPS virtual service group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - 'ServiceWeight' => [ - 'description' => 'The service weight.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'EditEnable' => [ - 'description' => 'Indicates whether the edit operation is supported.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'HttpsVServerGroupId' => [ - 'description' => 'The ID of the HTTPS virtual service group.'."\n", - 'type' => 'string', - 'example' => '353', - ], - 'VsMetaInfo' => [ - 'type' => 'string', - ], - 'VServiceList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Port' => [ - 'type' => 'string', - ], - 'Protocol' => [ - 'type' => 'string', - ], - 'VServerGroupId' => [ - 'type' => 'string', - ], - 'VServerGroupName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'SlbType' => [ - 'type' => 'string', - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', 'title' => ''], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Data' => ['description' => 'Data overview.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'Status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'Success' => ['description' => 'Request result, with the following values:'."\n" + ."\n" + .'- `true`: The request is successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9515ACA4-E94D-440D-989E-C379FCED****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": 500,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RemoveAuthPolicy', + 'summary' => 'Delete service authentication rules using the RemoveAuthPolicy interface.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:RemoveAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAB345F4-3AC3-560C-B653-65717703****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"ID\\",\\n \\"SlbId\\": \\"lb-bp1kmnli3hdpreptw2ah3\\",\\n \\"SlbIp\\": \\"121.199.XX.XX\\",\\n \\"SlbPort\\": \\"80,443\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"GatewayId\\": \\"1\\",\\n \\"GmtCreate\\": \\"2022-01-14 14:39:16\\",\\n \\"GatewaySlbMode\\": \\"UserSelect\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"关联中\\",\\n \\"VServerGroupId\\": \\"353\\",\\n \\"HttpPort\\": 80,\\n \\"HttpsPort\\": 443,\\n \\"ServiceWeight\\": 80,\\n \\"EditEnable\\": false,\\n \\"HttpsVServerGroupId\\": \\"353\\",\\n \\"VsMetaInfo\\": \\"[{\\\\\\"protocol\\\\\\":\\\\\\"HTTP\\\\\\",\\\\\\"vServerGroupName\\\\\\":\\\\\\"k8s/80/****\\\\\\",\\\\\\"port\\\\\\":80,\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-bp***\\\\\\"},{\\\\\\"protocol\\\\\\":\\\\\\"HTTPS\\\\\\",\\\\\\"vServerGroupName\\\\\\":\\\\\\"k8s/443/***\\\\\\",\\\\\\"port\\\\\\":443,\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-bp*****\\\\\\"}]\\",\\n \\"VServiceList\\": [\\n {\\n \\"Port\\": \\"443\\",\\n \\"Protocol\\": \\"HTTPS\\",\\n \\"VServerGroupId\\": \\"rsp-bp183l2x70***\\",\\n \\"VServerGroupName\\": \\"k8s/31**0/***/istio-system/clusterid\\"\\n }\\n ],\\n \\"SlbType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListGatewaySlb', ], - 'GetGatewayOption' => [ - 'summary' => 'Obtains the global parameters of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'RemoveZooKeeperSaslUser' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '92787', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217283', + 'abilityTreeNodes' => ['FEATUREmse2TF2YB'], ], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '429', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mse_prepaid_public_cn-****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'UserNames', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'A username.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', + 'title' => '', + 'description' => 'The list of usernames to remove.', + 'example' => '', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Reload', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Specifies whether to apply the change immediately.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C92F4A4D-A2FD-593E-839E-F3D4DFD2****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned. The value 200 indicates that the request is successfully processed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The detailed configurations of the gateway.'."\n" - ."\n" - .'* **TraceDetails**: the sampling description of Managed Service for OpenTelemetry. Content: TraceEnabled indicates whether Managed Service for OpenTelemetry is activated. Sample indicates the sampling rate of Managed Service for OpenTelemetry.'."\n" - .'* **LogConfigDetails**: the description of Simple Log Service. Content: LogEnabled indicates whether Simple Log Service is activated. ProjectName indicates the Simple Log Service project to which logs are delivered. LogStoreName indicates the name of the Logstore.'."\n" - .'* **EnableHardwareAcceleration**: indicates whether hardware acceleration is enabled.'."\n" - .'* **DisableHttp2Alpn**: indicates whether the HTTP/2 protocol is disabled.'."\n" - .'* **EnableWaf**: indicates whether Web Application Firewall (WAF) is enabled.'."\n", - 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': False}, \'TraceDetails\': {\'TraceEnabled\': False}}', - '$ref' => '#/components/schemas/GatewayOption', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '56D9E600-6348-4260-B35F-583413F****', 'title' => ''], + 'Data' => ['description' => 'The data returned. A value of `true` indicates that the operation was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'title' => '', + 'description' => 'The result of the call.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RemoveZooKeeperSaslUser', + 'summary' => 'Deletes the specified ZooKeeper SASL users.', + 'changeSet' => [], + 'ramActions' => [ [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C92F4A4D-A2FD-593E-839E-F3D4DFD2****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TraceDetails\\": {\\n \\"TraceEnabled\\": true,\\n \\"Sample\\": 0,\\n \\"TraceType\\": \\"XTRACE\\",\\n \\"ServiceId\\": 0,\\n \\"ServicePort\\": \\"\\"\\n },\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"\\",\\n \\"LogStoreName\\": \\"\\"\\n },\\n \\"EnableHardwareAcceleration\\": true,\\n \\"DisableHttp2Alpn\\": true,\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayOption', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'ListSecurityGroupRule' => [ - 'summary' => 'Queries the security group rules of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'RestartCluster' => [ + 'summary' => 'Restarts a registry.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'update', + 'abilityTreeCode' => '17093', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID', - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****', 'title' => ''], + ], + [ + 'name' => 'PodNameList', + 'in' => 'query', + 'schema' => ['description' => 'The names of pods. You can specify the names of multiple pods at a time. Separate multiple pod names with commas (,). Example: mse-a8aba010-1629719288255-reg-center-0-1,mse-a8aba010-1629719288255-reg-center-0-2.'."\n" + ."\n" + .'The specified pods must belong to the current cluster and be associated with the specified instance. Otherwise, a restart exception occurs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-a8aba010-1629719288255-reg-center-0-1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the security group authorization record.'."\n", - 'type' => 'string', - 'example' => '21', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-bp1cg6qlyjepj0y6cf2c', - ], - 'PortRange' => [ - 'description' => 'The port range.'."\n", - 'type' => 'string', - 'example' => '8000/8000', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type.'."\n", - 'type' => 'string', - 'example' => 'tcp', - ], - 'AuthCidrs' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'GatewayId' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-12a432a1f5da423997d8880bd32c304d', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - ], - ], - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'RestartCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:RestartCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"21\\",\\n \\"SecurityGroupId\\": \\"sg-bp1cg6qlyjepj0y6cf2c\\",\\n \\"PortRange\\": \\"8000/8000\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"AuthCidrs\\": [\\n \\"\\"\\n ],\\n \\"GatewayId\\": 81,\\n \\"GatewayUniqueId\\": \\"gw-12a432a1f5da423997d8880bd32c304d\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"Description\\": \\"测试\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListSecurityGroupRule', ], - 'ListSecurityGroup' => [ - 'summary' => 'Obtains the information about security groups.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'RetryCluster' => [ + 'summary' => 'Retries a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'update', + 'abilityTreeCode' => '17094', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID', - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e98e40675aaf49bda082137d158e1585', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-st21ri2****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-8vb8gsmrqyc35k645rk6', - ], - 'SecurityGroupName' => [ - 'description' => 'The name of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg2', - ], - 'VpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1b', - ], - 'SecurityGroupType' => [ - 'description' => 'The type of the security group. Valid values:'."\n" - ."\n" - .'* normal: basic security group'."\n" - .'* enterprise: advanced security group For more information, see [Advanced security groups](~~120621~~).'."\n", - 'type' => 'string', - 'example' => 'enterprise', - ], - ], - ], - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RetryCluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:RetryCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-8vb8gsmrqyc35k645rk6\\",\\n \\"SecurityGroupName\\": \\"sg2\\",\\n \\"VpcId\\": \\"vpc-bp1b\\",\\n \\"SecurityGroupType\\": \\"enterprise\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListSecurityGroup', ], - 'UpdateGatewaySpec' => [ - 'summary' => 'Updates the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'SelectGatewaySlb' => [ + 'summary' => 'Queries an idle Server Load Balancer (SLB) instance that is associated with a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -42939,917 +29060,594 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '网关名称', - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['description' => 'The name of the SLB instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-slb', 'title' => ''], ], [ - 'name' => 'Spec', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '节点规格', - 'description' => 'The node specifications of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MSE_GTW_16_32_200_c' => 'MSE_GTW_16_32_200_c', - 'MSE_GTW_2_4_200_c' => 'MSE_GTW_2_4_200_c', - 'MSE_GTW_4_8_200_c' => 'MSE_GTW_4_8_200_c', - 'MSE_GTW_8_16_200_c' => 'MSE_GTW_8_16_200_c', - ], - 'example' => 'MSE_GTW_4_8_200_c', - ], + 'schema' => ['description' => 'The type of the SLB instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PUB_NET', 'title' => ''], ], [ - 'name' => 'Replica', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '节点数量', - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be850****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E00C6D90-A28A-5813-8981-0459AA436F46'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'gw-892ehbv7gg56******', + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlbId' => ['description' => 'The ID of the SLB instance.'."\n", 'type' => 'string', 'example' => 'lb-bp14lqiw5n96hq2****', 'title' => ''], + 'SlbName' => ['description' => 'The name of the SLB instance.'."\n", 'type' => 'string', 'example' => 'MseGatewaySlb-gw', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E00C6D90-A28A-5813-8981-0459AA436F46\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"SlbId\\": \\"lb-bp14lqiw5n96hq2****\\",\\n \\"SlbName\\": \\"MseGatewaySlb-gw\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SelectGatewaySlb', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:SelectGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"gw-892ehbv7gg56******\\"\\n}","type":"json"}]', - 'title' => 'UpdateGatewaySpec', - 'description' => 'You can call this operation to update the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway. If you add nodes or increase the specifications, you will incur fees. For more information, see [Pricing](~~250950~~).'."\n", ], - 'SelectGatewaySlb' => [ - 'summary' => 'Queries an idle Server Load Balancer (SLB) instance that is associated with a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'TagResources' => [ + 'summary' => 'Adds tags to specified resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '143129', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the SLB instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-slb', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Type', + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- CLUSTER: a registration and configuration center.'."\n" + ."\n" + .'- GATEWAY: a cloud-native gateway.'."\n" + ."\n" + .'- GOVERNANCEAPPLICATION: a microservice administration application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'CLUSTER、GATEWAY、GOVERNANCEAPPLICATION'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the SLB instance.'."\n", - 'type' => 'string', + 'description' => 'The resource ID.'."\n" + ."\n" + .'- *Registration and configuration center*: the instance ID.'."\n" + ."\n" + .'- *Cloud-native gateway*: the unique ID of the gateway.'."\n" + ."\n" + .'- *Microservice administration application*: the AppID of the microservice administration application. Note that this is not the LicenseKey.'."\n" + ."\n" + .'> The number in the parameter name specifies the index of the instance ID. For example:'."\n" + ."\n" + .'- **ResourceId.0** specifies the first instance ID.'."\n" + ."\n" + .'- **ResourceId.1** specifies the second instance ID.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2st29t16'."\n" + .'hkhon1****@0932f4959f8****', 'title' => ''], 'required' => false, - 'example' => 'PUB_NET', + 'maxItems' => 51, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'A list of tags. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A collection of tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. The tag key cannot be an empty string. It can be up to 128 characters in length. The tag key cannot start with \\`aliyun\\` or \\`acs:\\`. The tag key cannot contain \\`http\\://\\` or \\`https\\://\\`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'env'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be850****', + 'maxItems' => 21, + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E00C6D90-A28A-5813-8981-0459AA436F46', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'SlbId' => [ - 'description' => 'The ID of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'lb-bp14lqiw5n96hq2****', - ], - 'SlbName' => [ - 'description' => 'The name of the SLB instance.'."\n", - 'type' => 'string', - 'example' => 'MseGatewaySlb-gw', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0A79810-9396-521C-A09D-E757B3E2BAF4', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Succ', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0A79810-9396-521C-A09D-E757B3E2BAF4\\",\\n \\"Message\\": \\"Succ\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'TagResources', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E00C6D90-A28A-5813-8981-0459AA436F46\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"SlbId\\": \\"lb-bp14lqiw5n96hq2****\\",\\n \\"SlbName\\": \\"MseGatewaySlb-gw\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'SelectGatewaySlb', ], - 'AddServiceSource' => [ - 'summary' => 'Adds a Nacos service source.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UntagResources' => [ + 'summary' => 'Untags resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service source.'."\n" - ."\n" - .'* K8s: Container Service for Kubernetes (ACK) cluster'."\n" - .'* NACOS: Nacos instance', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'The Ingress configuration.'."\n", - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service source.'."\n" - ."\n" - .'* K8s: ACK cluster'."\n" - .'* NACOS: MSE Nacos instance', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'K8s,MSE', - ], - ], - [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to monitor Ingress classes.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'c9ad2a0717032427e920754e25b49e3b5', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace whose resources you want to monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'istio', - ], - ], - [ - 'name' => 'GatewayUniqueId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to update the Ingress status.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'IngressOptionsRequest', + 'name' => 'ResourceType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of service groups.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableIngress' => [ - 'description' => 'The group to which the service belongs.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'IngressClass' => [ - 'description' => 'An array of service root paths.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'com.test.xxx', - ], - 'WatchNamespace' => [ - 'description' => 'The root path of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'EnableStatus' => [ - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh-CN: Chinese. This is the default value.'."\n" - .'* en-US: English.'."\n" - .'* ja: Japanese.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* CLUSTER: MSE instance'."\n" + .'* GATEWAY: cloud-native gateway'."\n", 'type' => 'string', 'required' => true, 'example' => 'CLUSTER'], ], [ - 'name' => 'ToAuthorizeSecurityGroups', + 'name' => 'All', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of security groups to be authorized. You can specify security groups to allow backend services to access data sources that you create.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp1acepclex0vmi1****', - ], - 'PortRange' => [ - 'description' => 'The authorized port range of the security group. You can select multiple port ranges. Separate each port range with a comma (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8080/8080,9000/10000', - ], - 'Description' => [ - 'description' => 'The description of the authorization record.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule for xxx', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to delete all tags. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'GroupList', + 'name' => 'ResourceId', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The data structure.'."\n", + 'title' => '', + 'description' => 'The resource IDs. A maximum of 50 resource IDs can be specified.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NACOS', - ], - 'required' => false, + 'items' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> This parameter specifies the instance ID that is passed. Examples:'."\n" + ."\n" + .'* **ResourceId.1** specifies that the first instance ID is passed.'."\n" + .'* **ResourceId.2** specifies that the second instance ID is passed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2st29t16', 'title' => ''], + 'required' => true, + 'maxItems' => 51, + 'example' => '', ], ], [ - 'name' => 'PathList', + 'name' => 'TagKey', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The HTTP status code returned.'."\n", + 'title' => '', + 'description' => 'The tag keys. A maximum of 20 tag keys are supported.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], + 'items' => ['description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key must be 1 to 128 characters in length. The tag key cannot start with acs: or aliyun or contain [http:// or https://.](http://https://。)'."\n", 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], 'required' => false, + 'maxItems' => 21, + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh-CN (default): Chinese'."\n" - .'* en-US: English'."\n" - .'* ja: Japanese'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The response data.'."\n", - 'type' => 'string', - 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', - ], - 'HttpStatusCode' => [ - 'description' => 'code', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'mse-200-105', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7', - ], - 'Code' => [ - 'description' => 'duplicatedClusterAliasName', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'duplicated cluster alias name', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'mse-100-007', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '63', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UntagResources', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 63\\n}","type":"json"}]', - 'title' => 'AddServiceSource', ], - 'AddGatewayServiceVersion' => [ - 'summary' => 'Adds a service version for a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateAcl' => [ + 'summary' => 'Modifies an IP address whitelist.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '90280', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '17096', + 'abilityTreeNodes' => ['FEATUREmse3FEC0V'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ServiceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '33', - ], - ], - [ - 'name' => 'ServiceVersion', + 'name' => 'AclEntryList', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{\\"name\\":\\"v1\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v1\\"}]}', - ], + 'schema' => ['description' => 'The IP addresses or CIDR blocks in the IP address whitelist.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '192.168.0.0/XX,192.168.0.0/XX', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-913a49bab6c5461187a3305fb8da****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BA4046B6-CFC6-583C-B608-DD75011A590F', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned. The value 200 indicates that the request is successfully processed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The ID of the gateway service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '330', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-100', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateAcl', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateAcl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA4046B6-CFC6-583C-B608-DD75011A590F\\",\\n \\"HttpStatusCode\\": 403,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 330\\n}","type":"json"}]', - 'title' => 'AddGatewayServiceVersion', ], - 'DeleteServiceSource' => [ - 'summary' => 'Deletes a gateway service source.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateAuthPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '24910', - 'abilityTreeNodes' => [ - 'FEATUREmseQRG9VI', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17097', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], ], 'parameters' => [ [ - 'name' => 'SourceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '17', - ], + 'schema' => ['description' => 'The rule name.', 'type' => 'string', 'required' => false, 'example' => 'demo-test', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be850****', - ], + 'schema' => ['description' => 'The service source that the application accesses.', 'type' => 'string', 'required' => false, 'example' => 'edasmsc', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '432', 'title' => ''], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'abcde@12345', 'title' => ''], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => 'The Protocol Type. Valid values:'."\n" + ."\n" + .'- **SPRING\\_CLOUD**.'."\n" + ."\n" + .'- **DUBBO**.'."\n" + ."\n" + .'- **istio**.', 'type' => 'string', 'required' => false, 'example' => 'SPRING_CLOUD', 'title' => ''], + ], + [ + 'name' => 'AuthRule', + 'in' => 'query', + 'schema' => ['description' => 'The content of the service authentication rule.', 'type' => 'string', 'required' => false, 'example' => '[{\\"all\\":true,\\"appIds\\":[\\"f6xqzbao96@4adfaf3c92c947a\\"],\\"black\\":false}]', 'title' => ''], + ], + [ + 'name' => 'K8sNamespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace ID of the Kubernetes cluster.', 'type' => 'string', 'required' => false, 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2CEF593F-D60C-5449-9E98-15CA6ECD9189', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '83E3909D-D26F-5D97-B73B-407A26***', 'title' => ''], + 'Message' => ['description' => 'The message that is returned for the request.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'Success' => ['description' => 'The result of the request. Valid values: - true: The request is successful. - false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"83E3909D-D26F-5D97-B73B-407A26***\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Data\\": \\"{}\\",\\n \\"Code\\": 500,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateAuthPolicy', + 'summary' => 'Updates service authentication rules through the UpdateAuthPolicy operation.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CEF593F-D60C-5449-9E98-15CA6ECD9189\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteServiceSource', ], - 'DeleteGatewayServiceVersion' => [ - 'summary' => 'Deletes a service version from a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateBlackWhiteList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -43858,2610 +29656,1699 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '90283', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36595', + 'abilityTreeNodes' => ['FEATUREmseWSG2U5'], ], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '777', - ], + 'schema' => ['description' => 'The ID of the blacklist.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'ServiceVersion', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The version of the service.'."\n", + 'description' => 'The type of the resource.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{\\"name\\":\\"app\\",\\"labels\\":[{\\"key\\":\\"app\\",\\"value\\":\\"demo-server\\"}]}', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'GATEWAY', ], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-b6988bd16920479d9104e1729f97****', - ], + 'schema' => ['description' => 'The type of the blacklist or whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'IP'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The content of the blacklist.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.2.11'], + ], + [ + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", + 'description' => 'Specifies whether to enable the blacklist or whitelist.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'enumValueTitles' => ['off' => '', 'on' => ''], + 'example' => 'on', ], ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the whitelist.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ResourceIdJsonList', + 'in' => 'query', + 'schema' => ['description' => 'The resource IDs in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '[123]'], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a note'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '29D52777-BE96-563E-BC6B-796ACE47A7A5', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The return value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The ID of the record.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '13'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D52777-BE96-563E-BC6B-796ACE47A7A5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', - 'title' => 'DeleteGatewayServiceVersion', - ], - 'DeleteGatewayService' => [ - 'summary' => 'Deletes a service from a gateway', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 13\\n}","type":"json"}]', + 'title' => 'UpdateBlackWhiteList', + 'summary' => 'Modifies the blacklist or whitelist of a gateway.', + 'changeSet' => [ + ['createdAt' => '2023-07-17T07:11:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-15T07:39:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-28T13:10:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-13T03:28:15.000Z', 'description' => 'Request parameters changed'], ], - 'tags' => [ - 'gateway', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'UpdateCircuitBreakerRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '25194', - 'abilityTreeNodes' => [ - 'FEATUREmse5GGXKF', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '167822', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '190', - ], + 'schema' => ['title' => '', 'description' => 'The microservice namespace to which the application belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'GatewayId', + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'Threshold', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", + 'type' => 'number', + 'format' => 'float', 'required' => false, - 'example' => '60', + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => '0.8', ], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f', + 'title' => '', + 'description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], + ], + [ + 'name' => 'Strategy', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" + 'title' => '', + 'description' => 'The threshold type.'."\n" ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' slow call proportion'."\n" + ."\n" + .' '."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' abnormal proportion'."\n" + ."\n" + .' '."\n", + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'zh', + 'enumValueTitles' => ['', ''], + 'example' => '0', ], ], + [ + 'name' => 'RetryTimeoutMs', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period. The value must be an integral multiple of 1,000. Default value: 10000. This value indicates 10 seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes. The default value is 20000. This value indicates 20 seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000'], + ], + [ + 'name' => 'MaxAllowedRtMs', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'HalfOpenBaseAmountPerStep', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'HalfOpenRecoveryStepNum', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of circuit breaking recovery steps. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B3545F76-6ED1-586F-8DB9-ECE07985F381', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The details of the rule.'."\n", 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190', - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => 'The source type of the service.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'SourceId' => [ - 'description' => 'The ID of the service source.'."\n", + 'Namespace' => ['title' => '', 'description' => 'The microservice namespace to which the application belongs.'."\n", 'type' => 'string', 'example' => 'default'], + 'Id' => ['title' => '', 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['title' => '', 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", 'type' => 'string', 'example' => '/a'], + 'Strategy' => [ + 'title' => '', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' slow call proportion'."\n" + ."\n" + .' '."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' abnormal proportion'."\n" + ."\n" + .' '."\n", 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceNameInRegistry' => [ - 'description' => 'The name of the service registered with the service registry.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'MetaInfo' => [ - 'description' => 'The basic information about the service.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Ips' => [ - 'description' => 'IP'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'IP'."\n", - 'type' => 'string', - 'example' => '127.0.1.12', - ], - ], - 'GmtCreate' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-14 14:39:16', - ], - 'GmtModified' => [ - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', + 'format' => 'int32', + 'enumValueTitles' => ['', ''], + 'example' => '0', ], + 'Threshold' => ['title' => '', 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.8'], + 'Enable' => ['title' => '', 'description' => 'Indicates whether the rule is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RetryTimeoutMs' => ['title' => '', 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'StatIntervalMs' => ['title' => '', 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20000'], + 'AppId' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'MaxAllowedRtMs' => ['title' => '', 'description' => 'The maximum RT. Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'MinRequestAmount' => ['title' => '', 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'HalfOpenBaseAmountPerStep' => ['title' => '', 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'HalfOpenRecoveryStepNum' => ['title' => '', 'description' => 'The number of circuit breaking recovery steps.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' The request was successful.'."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' The request failed.'."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Strategy\\": 0,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"StatIntervalMs\\": 20000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateCircuitBreakerRule', + 'summary' => 'Updates a circuit breaking rule.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3545F76-6ED1-586F-8DB9-ECE07985F381\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 190,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\",\\n \\"SourceId\\": 1,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.1.12\\"\\n ],\\n \\"GmtCreate\\": \\"2022-01-14 14:39:16\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteGatewayService', ], - 'UpdateGatewayServiceTrafficPolicy' => [ - 'summary' => 'Updates the traffic policy of a service.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateCluster' => [ + 'summary' => 'Modifies the information about an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '113905', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'abilityTreeCode' => '17098', + 'abilityTreeNodes' => ['FEATUREmseY3D6DK'], ], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '429', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'ServiceId', + 'name' => 'ClusterAliasName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '411', - ], + 'schema' => ['description' => 'The alias of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cluster-1', 'title' => ''], ], [ - 'name' => 'GatewayTrafficPolicy', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The traffic policy of the gateway.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/TrafficPolicy', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'MaintenanceStartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-75c5036c083e4f89ba8ef9fafff2e902', - ], + 'schema' => ['description' => 'The start time of the O\\&M window.'."\n", 'type' => 'string', 'required' => false, 'example' => '02:00', 'title' => ''], + ], + [ + 'name' => 'MaintenanceEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the O\\&M window.'."\n", 'type' => 'string', 'required' => false, 'example' => '06:00', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* **zh-CN** (default): Chinese'."\n" - .'* **en-US**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '11A61389-F896-5231-A4FB-074D9E2E0055', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request was successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'example' => '{\'GatewayUniqueId\': \'gw-2b8ebd75dc554c37a4279ba9917379f2\', \'Id\': 417, \'GatewayTrafficPolicy\': {\'LoadBalancerSettings\': {\'LoadbalancerType\': \'ROUND_ROBIN\'}, \'TlsSetting\': {\'TlsMode\': \'DISABLE\'}}}', - '$ref' => '#/components/schemas/GatewayService', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-100', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11A61389-F896-5231-A4FB-074D9E2E0055\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"Name\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"GatewayTrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"\\",\\n \\"CaCertContent\\": \\"\\",\\n \\"Sni\\": \\"\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"\\",\\n \\"Path\\": \\"\\",\\n \\"TTL\\": \\"0s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"\\"\\n },\\n \\"WarmupDuration\\": 0\\n }\\n },\\n \\"GatewayUniqueId\\": \\"\\",\\n \\"MetaInfo\\": \\"\\",\\n \\"Namespace\\": \\"\\",\\n \\"GroupName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateGatewayServiceTrafficPolicy', ], - 'UpdateGatewayServiceVersion' => [ - 'summary' => 'Updates the service version of a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateClusterSpec' => [ + 'summary' => 'Updates the number of nodes or specifications of a registry and configuration center cluster (supports both pay-as-you-go and subscription).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '90281', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], + 'systemTags' => ['operationType' => 'update', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '575', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'ServiceVersion', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{\\"name\\":\\"v3\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v3\\"}]}', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'InstanceCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-eccf313e2224438ba53d95d039e5****', - ], + 'schema' => ['description' => 'The number of destination nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '3'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ClusterSpecification', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", + 'description' => 'The destination engine specifications.', + 'enumValueTitles' => ['MSE_SC_4_8_200_c' => 'MSE_SC_4_8_200_c', 'MSE_SC_16_32_200_c' => 'MSE_SC_16_32_200_c', 'MSE_SC_2_4_200_c' => 'MSE_SC_2_4_200_c', 'MSE_SC_8_16_200_c' => 'MSE_SC_8_16_200_c'], 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'example' => 'MSE_SC_2_4_200_c', + 'title' => '', ], ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => ['description' => 'The MSE version.', 'type' => 'string', 'required' => false, 'example' => 'mse_pro'."\n", 'title' => ''], + ], + [ + 'name' => 'PubNetworkFlow', + 'in' => 'query', + 'schema' => ['description' => 'Internet bandwidth', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically pay after placing an order. If this value is false, this interface will return a payment URL for the order, which you can manually confirm to pay', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6580AA6-E285-58D2-B00B-12C051B3B7BF', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '614', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'This is a reserved field.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorCode' => ['description' => 'The error code. Take note of the following items:'."\n" + ."\n" + .'- If the request is successful: The **ErrorCode** field is not returned.'."\n" + ."\n" + .'- If the request fails: The **ErrorCode** field is returned. For more information, see the **Error codes** section in this topic.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"null\\",\\n \\"ErrorCode\\": \\"mse-100-000\\"\\n}","type":"json"}]', + 'title' => 'UpdateClusterSpec', + 'description' => 'Updates the number of nodes or specifications of a registry and configuration center cluster (supports both pay-as-you-go and subscription). Adding nodes or upgrading specifications will incur corresponding fees. For more information, see \\[Pricing]\\(`~~1806469~~`).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateClusterSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6580AA6-E285-58D2-B00B-12C051B3B7BF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 614\\n}","type":"json"}]', - 'title' => 'UpdateGatewayServiceVersion', ], - 'ListServiceSource' => [ - 'summary' => 'Queries a list of associated sources.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateConfig' => [ + 'summary' => 'Updates the configurations of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24908', - 'abilityTreeNodes' => [ - 'FEATUREmse5GGXKF', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17099', + 'abilityTreeNodes' => ['FEATUREmseY3D6DK'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c51a15c7ee934a4fb945ccf35fe1****', - ], + 'schema' => ['description' => 'The extended request parameter in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the type of the returned service source. If this parameter is not specified, service sources of all types are returned. Valid values:'."\n" - ."\n" - .'* K8s'."\n" - .'* MSE'."\n" - .'* MSE_ZK'."\n" - .'* SAE'."\n" - .'* EDAS', - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => ['description' => 'The format of the configurations. Supported formats include TEXT, JSON, XML, and HTML.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TEXT', 'title' => ''], + ], + [ + 'name' => 'TickTime', + 'in' => 'query', + 'schema' => ['description' => 'The time unit. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2000', 'title' => ''], + ], + [ + 'name' => 'InitLimit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum connection duration of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'SyncLimit', + 'in' => 'query', + 'schema' => ['description' => 'The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxClientCnxns', + 'in' => 'query', + 'schema' => ['description' => 'The number of connections between a single client and a single server in ZooKeeper configuration.
'."\n" + .'If this parameter is set to 0, no limits are imposed on the number of connections.
', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'OpenSuperAcl', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether super permissions are enabled. This parameter is valid for ZooKeeper instances. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => 'The username of the account.'."\n" + ."\n" + .'> This parameter is required when OpenSuperAcl is set to true.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + ], + [ + 'name' => 'PassWord', + 'in' => 'query', + 'schema' => ['description' => 'The password of the account.'."\n" + ."\n" + .'> This parameter is required when OpenSuperAcl is set to true.', 'type' => 'string', 'required' => false, 'example' => 'password', 'title' => ''], + ], + [ + 'name' => 'JuteMaxbuffer', + 'in' => 'query', + 'schema' => ['description' => 'The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. Unit: bytes.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1048575', 'title' => ''], + ], + [ + 'name' => 'AutopurgePurgeInterval', + 'in' => 'query', + 'schema' => ['description' => 'The reserved field.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'none', 'title' => ''], + ], + [ + 'name' => 'AutopurgeSnapRetainCount', + 'in' => 'query', + 'schema' => ['description' => 'The reserved field.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'none', 'title' => ''], + ], + [ + 'name' => 'ConfigAuthEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable RAM authentication for the configuration center in Nacos:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled'."\n" + ."\n" + .'> Before you set this parameter, call the QueryConfig operation to obtain the ConfigAuthSupported parameter to check whether the current cluster supports this feature.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'NamingAuthEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable RAM authentication for the Accreditation Centre in Nacos:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled'."\n" + ."\n" + .'> Before you set this parameter, call the QueryConfig operation to obtain the NamingAuthSupporte parameter to check whether the current cluster supports this feature.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'MCPEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether MCP is enabled in Nacos configuration. Valid values:'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled'."\n" + ."\n" + .'> Before you set this parameter, call the QueryConfig operation to obtain the MCPSupported parameter to check whether the current cluster supports this feature.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-st2212****', 'title' => ''], + ], + [ + 'name' => 'ConfigSecretEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the configuration encryption feature for the configuration center in Nacos. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.'."\n" + ."\n" + .'> Before you set this parameter, call the QueryConfig operation to obtain the ConfigSecretSupported parameter to check whether the current cluster supports this feature.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'MinSessionTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The minimum timeout period in ZooKeeper configuration. Unit: seconds.', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'MaxSessionTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The maximum timeout period in ZooKeeper configuration. Unit: seconds.', 'type' => 'string', 'example' => '1000', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SnapshotCount', + 'in' => 'query', + 'schema' => ['description' => 'The frequency at which snapshots are generated in ZooKeeper configuration', 'type' => 'string', 'required' => false, 'example' => '100000', 'title' => ''], + ], + [ + 'name' => 'ExtendedTypesEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable TTL configuration in ZooKeeper parameters.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EurekaSupported', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable Eureka protocol support in Nacos', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TLSEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable TLS transmission link encryption in Nacos', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ConsoleUIEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the Nacos open-source console', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Enable4lw', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the four-character command access feature', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AuthEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable forced Simple Authentication and Security Layer (SASL) authentication. After this feature is enabled, clients that do not perform SASL authentication cannot access the cluster', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'UpdateConfig', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'UpdateEngineNamespace' => [ + 'summary' => 'Updates a namespace for the Nacos engine.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17100', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name', 'title' => ''], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => 'The description of the cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'public', 'title' => ''], + ], + [ + 'name' => 'ServiceCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of active services.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-09k1q11****', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B8C4B0D8-EBB9-5F20-8295-04224FBE5529', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Address' => [ - 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster or the endpoint of the Microservices Engine (MSE) instance.'."\n", - 'type' => 'string', - 'example' => '***', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'NACOS', - ], - 'Source' => [ - 'description' => 'The type of the service source.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'BindingWithGateway' => [ - 'description' => 'Indicates whether the service source is associated with the gateway. The value 1 indicates that the service source is associated with the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'SourceUniqueId' => [ - 'description' => 'The unique ID of the service source.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-***', - ], - 'IngressOptions' => [ - 'description' => 'The information about the support for Ingresses by applications.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableIngress' => [ - 'description' => 'Indicates whether Ingresses are enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IngressClass' => [ - 'description' => 'The Ingress class.'."\n", - 'type' => 'string', - 'example' => 'com.test.xxx', - ], - 'WatchNamespace' => [ - 'description' => 'The namespace that you want to monitor.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'EnableStatus' => [ - 'description' => 'Indicates whether the Ingress status is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-2u9uhd9283hd92hgd39g239dg2*****', - ], - 'GroupList' => [ - 'description' => 'The array of service groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - ], - 'PathList' => [ - 'description' => 'The array of root paths of service lists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The root path of the service list.'."\n", - 'type' => 'string', - 'example' => '/path', - ], - ], - 'Invalid' => [ - 'title' => '来源是否有效', - 'type' => 'boolean', - ], - ], + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* `0`: global configuration'."\n" + .'* `1`: default namespace'."\n" + .'* `2`: custom namespace'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NamespaceShowName' => ['description' => 'The display name of the namespace.'."\n", 'type' => 'string', 'example' => 'mytestshowname', 'title' => ''], + 'Quota' => ['description' => 'The quota of configurations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'public', 'title' => ''], + 'NamespaceDesc' => ['description' => 'The description of the namespace.'."\n", 'type' => 'string', 'example' => 'mytest', 'title' => ''], + 'ConfigCount' => ['description' => 'The quota value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": {\\n \\"Type\\": 1,\\n \\"NamespaceShowName\\": \\"mytestshowname\\",\\n \\"Quota\\": 1,\\n \\"Namespace\\": \\"public\\",\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"ConfigCount\\": 1\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateEngineNamespace', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8C4B0D8-EBB9-5F20-8295-04224FBE5529\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Address\\": \\"***\\",\\n \\"Type\\": \\"NACOS\\",\\n \\"Source\\": \\"MSE\\",\\n \\"BindingWithGateway\\": 1,\\n \\"GatewayId\\": 1,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"SourceUniqueId\\": \\"mse-cn-***\\",\\n \\"IngressOptions\\": {\\n \\"EnableIngress\\": true,\\n \\"IngressClass\\": \\"com.test.xxx\\",\\n \\"WatchNamespace\\": \\"default\\",\\n \\"EnableStatus\\": true\\n },\\n \\"GatewayUniqueId\\": \\"gw-2u9uhd9283hd92hgd39g239dg2*****\\",\\n \\"GroupList\\": [\\n \\"DEFAULT_GROUP\\"\\n ],\\n \\"PathList\\": [\\n \\"/path\\"\\n ],\\n \\"Invalid\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListServiceSource', ], - 'ListGatewayService' => [ - 'summary' => 'Queries a list of services that are subscribed to by a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateFlowRule' => [ + 'summary' => 'Updates a throttling rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '25193', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '159855', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The throttling threshold.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to enable the rule.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', 'required' => false, - 'example' => '1', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'ControlBehavior', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", + 'description' => 'The throttling effect.', + 'enumValueTitles' => ['', 2 => ''], 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'example' => '10', + 'docRequired' => false, + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'OrderItem', + 'name' => 'MaxQueueingTimeMs', 'in' => 'query', - 'schema' => [ - 'description' => 'The item based on which entries are sorted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreate', - ], + 'schema' => ['description' => 'The timeout period. Unit: milliseconds. This parameter is required if the ControlBehavior parameter is set to 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', 'title' => ''], ], [ - 'name' => 'DescSort', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable sorting.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******', 'title' => ''], ], [ - 'name' => 'FilterParams', + 'name' => 'LimitApp', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The parameters that are used to specify filter conditions. The values of the parameters are in the format of {"key1":"value1"}.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'SourceType' => [ - 'description' => 'The type of the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'ServiceProtocol' => [ - 'description' => 'The protocol of the service.'."\n" - ."\n" - .'* HTTP'."\n" - .'* HTTPS'."\n" - .'* HTTP2'."\n" - .'* GRPC'."\n" - .'* DUBBO'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HTTP2' => 'HTTP2', - 'HTTPS' => 'HTTPS', - 'HTTP' => 'HTTP', - 'DUBBO' => 'DUBBO', - 'GRPC' => 'GRPC', - ], - 'example' => 'HTTP', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The source application of the request.', 'type' => 'string', 'required' => false, 'example' => 'Spring-cloud-a', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F46CDBA4-B1EE-5C94-8A48-51C10177****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', 'title' => ''], + 'Code' => ['description' => 'The return value.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The data of the node.', 'type' => 'object', 'properties' => [ - 'TotalSize' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'PageNumber' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page. Default value: 10.'."\n", + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Resource' => ['description' => 'The interface resource name.', 'type' => 'string', 'example' => '/c', 'title' => ''], + 'ControlBehavior' => [ + 'description' => 'The throttling effect.', + 'enumValueTitles' => ['', 2 => ''], 'type' => 'integer', 'format' => 'int32', - 'example' => '10', + 'example' => '0', + 'title' => '', ], - 'Result' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'GatewayId' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'SourceId' => [ - 'description' => 'The ID of the service source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ServiceNameInRegistry' => [ - 'description' => 'The name of the service that is registered with the service registry.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'MetaInfo' => [ - 'description' => 'The metadata or IP addresses of the service.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Ips' => [ - 'description' => 'The list of IP addresses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '127.0.2.1', - ], - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'Versions' => [ - 'description' => 'The service version.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The version.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - ], - ], - ], - 'ServiceProtocol' => [ - 'description' => 'The protocol of the service.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ServicePort' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'HealehStatus' => [ - 'description' => 'The health status.'."\n" - ."\n" - .'* Health'."\n" - .'* Unhealthy'."\n" - .'* Unknown'."\n", - 'type' => 'string', - 'example' => 'Unhealthy', - ], - 'HealthStatus' => [ - 'description' => 'The health status.'."\n" - ."\n" - .'* Health'."\n" - .'* Unhealthy'."\n" - .'* Unknown'."\n", - 'type' => 'string', - 'example' => 'Unhealthy', - ], - 'HealthCheck' => [ - 'description' => 'Indicates whether health checks are performed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HealthCheckInfo' => [ - 'description' => 'The information about health checks.'."\n", - 'type' => 'object', - 'properties' => [ - 'Check' => [ - 'description' => 'Indicates whether checks are performed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Protocol' => [ - 'description' => 'The network protocol.'."\n", - 'type' => 'string', - 'example' => 'TCP', - ], - 'Timeout' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Interval' => [ - 'description' => 'The health check interval.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HealthyThreshold' => [ - 'description' => 'The threshold for healthy instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UnhealthyThreshold' => [ - 'description' => 'The threshold for unhealthy instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HttpPath' => [ - 'description' => 'The path to which the HTTP request for the health check is sent.'."\n", - 'type' => 'string', - 'example' => '/health', - ], - 'HttpHost' => [ - 'description' => 'The endpoint of the HTTP request for the health check.'."\n", - 'type' => 'string', - 'example' => 'http://172.168.0.1', - ], - 'ExpectedStatuses' => [ - 'description' => 'The expected status of the health check.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The expected HTTP status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - ], - ], - ], - 'UnhealthyEndpoints' => [ - 'description' => 'The array of endpoints of unhealthy instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The endpoint of the unhealthy instance.'."\n", - 'type' => 'string', - 'example' => '172.168.0.1', - ], - ], - 'GatewayTrafficPolicy' => [ - 'description' => 'The traffic management policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Tls' => [ - 'description' => 'The Transport Layer Security (TLS).'."\n", - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => 'DISABLE, SIMPLE, MUTUAL, ISTIO_MUTUAL', - 'description' => 'The TLS mode.'."\n" - ."\n" - .'* DISABLE'."\n" - .'* SIMPLE'."\n" - .'* MUTUAL'."\n" - .'* ISTIO_MUTUAL'."\n", - 'type' => 'string', - 'example' => 'SIMPLE', - ], - 'CertId' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'example' => '5******-cn-hangzhou', - ], - 'CaCertId' => [ - 'description' => 'The ID of the certification authority (CA) certificate.'."\n", - 'type' => 'string', - 'example' => '5******-cn-hangzhou', - ], - 'CaCertContent' => [ - 'description' => 'The public key of the CA certificate .'."\n", - 'type' => 'string', - 'example' => 'content', - ], - 'SubjectAltNames' => [ - 'description' => 'The array of subject aliases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subject alias.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - ], - 'Sni' => [ - 'description' => 'The Server Name Indication (SNI) value.'."\n", - 'type' => 'string', - 'example' => 'name-sni', - ], - ], - ], - 'LoadBalancerSettings' => [ - 'description' => 'The load balancing settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'LoadbalancerType' => [ - 'title' => 'ROUND_ROBIN, LEAST_CONN, RANDOM, CONSISTENT_HASH', - 'description' => 'The load balancing type.'."\n" - ."\n" - .'* ROUND_ROBIN'."\n" - .'* LEAST_CONN'."\n" - .'* RANDOM'."\n" - .'* CONSISTENT_HASH'."\n", - 'type' => 'string', - 'example' => 'RANDOM', - ], - 'ConsistentHashLBConfig' => [ - 'description' => 'The consistent hashing settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param', - ], - 'HttpCookie' => [ - 'description' => 'The cookie-based load balancing parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the cookie.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Path' => [ - 'description' => 'The path of the cookie.'."\n", - 'type' => 'string', - 'example' => '/path', - ], - 'Ttl' => [ - 'description' => 'The lifecycle of the cookie.'."\n", - 'type' => 'string', - 'example' => '360', - ], - ], - ], - 'MinimumRingSize' => [ - 'description' => 'The minimum value of the hash ring.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ConsistentHashLBType' => [ - 'title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', - 'description' => 'The type based on which consistent hashing load balancing is performed.'."\n" - ."\n" - .'* HEADER'."\n" - .'* COOKIE'."\n" - .'* SOURCE_IP'."\n" - .'* QUERY_PARAMETER'."\n", - 'type' => 'string', - 'example' => 'HEADER', - ], - ], - ], - 'WarmupDuration' => [ - 'description' => 'The prefetch time of the least connection load balancing.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - 'Ports' => [ - 'description' => 'The port array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - ], - 'ServiceFQDN' => [ - 'type' => 'string', - ], - 'DnsServerList' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'example' => '1.1.1.1:80', - ], - ], - ], - ], + 'MaxQueueingTimeMs' => ['description' => 'The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'Threshold' => ['description' => 'The throttling threshold.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], + 'Enable' => [ + 'description' => 'Indicates whether the rule is enabled.', + 'enumValueTitles' => ['true' => '', 'fasle' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hpn9ac29kz@e31a4b871******', 'title' => ''], + 'LimitApp' => ['description' => 'The source application of the request.', 'type' => 'string', 'example' => 'Spring-cloud-a', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'Success' => [ + 'description' => 'The result of the request.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 12,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/c\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 5,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hpn9ac29kz@e31a4b871******\\",\\n \\"LimitApp\\": \\"Spring-cloud-a\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F46CDBA4-B1EE-5C94-8A48-51C10177****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": 2,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.2.1\\"\\n ],\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"Versions\\": [\\n {\\n \\"Name\\": \\"v1\\"\\n }\\n ],\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServicePort\\": 80,\\n \\"HealehStatus\\": \\"Unhealthy\\",\\n \\"HealthStatus\\": \\"Unhealthy\\",\\n \\"HealthCheck\\": true,\\n \\"HealthCheckInfo\\": {\\n \\"Check\\": true,\\n \\"Protocol\\": \\"TCP\\",\\n \\"Timeout\\": 2,\\n \\"Interval\\": 2,\\n \\"HealthyThreshold\\": 2,\\n \\"UnhealthyThreshold\\": 2,\\n \\"HttpPath\\": \\"/health\\",\\n \\"HttpHost\\": \\"http://172.168.0.1\\",\\n \\"ExpectedStatuses\\": [\\n 200\\n ]\\n },\\n \\"UnhealthyEndpoints\\": [\\n \\"172.168.0.1\\"\\n ],\\n \\"GatewayTrafficPolicy\\": {\\n \\"Tls\\": {\\n \\"Mode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"5******-cn-hangzhou\\",\\n \\"CaCertId\\": \\"5******-cn-hangzhou\\",\\n \\"CaCertContent\\": \\"content\\",\\n \\"SubjectAltNames\\": [\\n \\"name\\"\\n ],\\n \\"Sni\\": \\"name-sni\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"param\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"name\\",\\n \\"Path\\": \\"/path\\",\\n \\"Ttl\\": \\"360\\"\\n },\\n \\"MinimumRingSize\\": 10000,\\n \\"ConsistentHashLBType\\": \\"HEADER\\"\\n },\\n \\"WarmupDuration\\": 10\\n }\\n },\\n \\"Ports\\": [\\n 8080\\n ],\\n \\"ServiceFQDN\\": \\"\\",\\n \\"DnsServerList\\": [\\n \\"1.1.1.1:80\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayService', ], - 'GetMseSource' => [ - 'summary' => 'Queries the existing Microservices Engine (MSE) Nacos instances that are service sources of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumer' => [ + 'summary' => 'Updates the consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24939', - 'abilityTreeNodes' => [ - 'FEATUREmseZM8SC5', - 'FEATUREmseRZJSHZ', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-90392d768a3847a7b804c505254d****', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'EncodeType', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1t50e045b5g7i3p****', - ], + 'schema' => ['description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* RSA'."\n" + .'* OCT'."\n", 'type' => 'string', 'required' => false, 'example' => 'RSA', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'Jwks', 'in' => 'query', - 'schema' => [ - 'description' => 'The MSE engine type. Valid values:'."\n" - ."\n" - .'* NACOS'."\n" - .'* ZOOKEEPER'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NACOS', - ], + 'schema' => ['description' => 'The JWT public key. The JSON format is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', 'title' => ''], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => ['description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Authorization', 'title' => ''], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable pass-through.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => ['description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HEADER', 'title' => ''], + ], + [ + 'name' => 'TokenPrefix', + 'in' => 'query', + 'schema' => ['description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Bearer ', 'title' => ''], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the key used for JWT-based identity authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iss', 'title' => ''], + ], + [ + 'name' => 'KeyValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of the key used for JWT-based identity authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcd', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the consumer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description.', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '63', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '', - 'zh' => '', - ], - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5EB2D865-B43F-5526-8F92-857718CF73A2', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n" - ."\n" - .'* If the request is successful, a success message is returned.'."\n" - .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the instance'."\n", - 'type' => 'string', - 'example' => 'mse_prepaid_public_cn-7pp2eec****', - ], - 'Address' => [ - 'description' => 'The endpoint of the instance.'."\n", - 'type' => 'string', - 'example' => 'mse-af1****-nacos-ans.mse.aliyuncs.com:8848', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'Nacos', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ClusterId' => [ - 'description' => 'The ID of cluster.'."\n", - 'type' => 'string', - 'example' => 'mse_', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 2\\n}","type":"json"}]', + 'title' => 'UpdateGatewayAuthConsumer', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EB2D865-B43F-5526-8F92-857718CF73A2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"mse_prepaid_public_cn-7pp2eec****\\",\\n \\"Address\\": \\"mse-af1****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"Type\\": \\"Nacos\\",\\n \\"Name\\": \\"test\\",\\n \\"ClusterId\\": \\"mse_\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetMseSource', ], - 'GetKubernetesSource' => [ - 'summary' => 'Obtains sources of all Container Service for Kubernetes (ACK) services in a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumerResource' => [ + 'summary' => 'Updates a list of resources on which permissions are granted to a gateway authentication consumer.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24906', - 'abilityTreeNodes' => [ - 'FEATUREmseE7U1OL', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c5d1aadb7df646cfb7065fbf75c1****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1t50e045b5g7i3p****', - ], + 'schema' => ['description' => 'The gateway authentication consumer ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'IsAll', + 'name' => 'ResourceList', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to obtain the information about all Kubernetes clusters. If you set the value to false, only the information about unassociated clusters is obtained.'."\n", - 'type' => 'boolean', + 'description' => 'The gateway authentication consumer ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'RouteId' => ['description' => 'The route ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7816', 'title' => ''], + 'RouteName' => ['description' => 'The name of the route.'."\n", 'type' => 'string', 'required' => false, 'example' => 'helo', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'k8s-demo', - ], - 'Cluster' => [ - 'description' => 'The ID of the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'cbc1efca895a64af097ff00b26f3f****', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the list of the resources was updated. Valid values:'."\n" + ."\n" + .'* true: The list of the resources was updated.'."\n" + .'* false: The list of the resources was not updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateGatewayAuthConsumerResource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumerResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"k8s-demo\\",\\n \\"Cluster\\": \\"cbc1efca895a64af097ff00b26f3f****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetKubernetesSource', ], - 'GetGatewayServiceDetail' => [ - 'summary' => 'Queries the details of a service.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumerResourceStatus' => [ + 'summary' => 'Updates the resource authorization status for the consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '39518', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '35', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-2a99625886d54722be94d92e9a69****', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-f4c960ad071a48a790b36324394c****', - ], + 'schema' => ['description' => 'The ID of the consumer.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'schema' => ['description' => 'The list of IDs of the authorized resources that a user wants to update.'."\n", 'type' => 'string', 'required' => true, 'example' => '1,2,3,4', 'title' => ''], + ], + [ + 'name' => 'ResourceStatus', + 'in' => 'query', + 'schema' => ['description' => 'The resource authorization status. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9802C54E-5CC5-5706-927B-993DBB6DCF2F', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => 'The source type of the service.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'SourceId' => [ - 'description' => 'The ID of the service source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceNameInRegistry' => [ - 'description' => 'The name of the service registered with the service registry.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'MetaInfo' => [ - 'description' => 'The basic information about the service.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Ips' => [ - 'description' => 'The IP address of the service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '127.0.1.12', - ], - ], - 'Versions' => [ - 'description' => 'The service version. This parameter is deprecated.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Label' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'version', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'LabelDetails' => [ - 'description' => 'The details of the tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'label', - ], - 'Values' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - ], - ], - ], - ], - 'VersionDetails' => [ - 'description' => 'The details of versions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceVersion' => [ - 'description' => 'The service version.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'example' => 'v2', - ], - 'Labels' => [ - 'description' => 'The tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'version', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'v2', - ], - ], - ], - ], - ], - ], - 'EndpointNum' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EndpointNumPercent' => [ - 'description' => 'The percentage of instances.'."\n", - 'type' => 'string', - 'example' => '20%', - ], - ], - ], - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GatewayTrafficPolicy' => [ - 'description' => 'The traffic policy of the service.'."\n", - 'example' => '{}', - '$ref' => '#/components/schemas/TrafficPolicy', - ], - 'HealthStatus' => [ - 'description' => 'The status of the health check. Valid values:'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'HealthCheck' => [ - 'description' => 'Indicates whether the health check is enabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ServiceProtocol' => [ - 'description' => 'The protocol of the service.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'Ports' => [ - 'description' => 'The array of service ports.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - ], - 'PortTrafficPolicyList' => [ - 'description' => 'The traffic policy of service ports.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object of the port traffic policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The port ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServicePort' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-2837hfd91h34dbg87364g*****', - ], - 'TrafficPolicy' => [ - 'description' => 'The traffic policy.'."\n", - '$ref' => '#/components/schemas/TrafficPolicy', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '1667460287386', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '1667460287386', - ], - ], - ], - ], - 'ServiceFQDN' => [ - 'type' => 'string', - ], - 'ServicePort' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DnsServerList' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'example' => '1.1.1.1:80', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the `%s` variable in the `ErrMessage` parameter.'."\n" + ."\n" + .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the execution was successful. Valid values:'."\n" + ."\n" + .'* true: The execution was successful.'."\n" + .'* false: The execution failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateGatewayAuthConsumerResourceStatus', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumerResourceStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9802C54E-5CC5-5706-927B-993DBB6DCF2F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": 1,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.1.12\\"\\n ],\\n \\"Versions\\": [\\n {\\n \\"Label\\": \\"version\\",\\n \\"Value\\": \\"v1\\",\\n \\"Type\\": \\"test\\"\\n }\\n ],\\n \\"LabelDetails\\": [\\n {\\n \\"Key\\": \\"label\\",\\n \\"Values\\": [\\n \\"v1\\"\\n ]\\n }\\n ],\\n \\"VersionDetails\\": [\\n {\\n \\"ServiceVersion\\": {\\n \\"Name\\": \\"v2\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"version\\",\\n \\"Value\\": \\"v2\\"\\n }\\n ]\\n },\\n \\"EndpointNum\\": 1,\\n \\"EndpointNumPercent\\": \\"20%\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GatewayTrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"\\",\\n \\"CaCertContent\\": \\"\\",\\n \\"Sni\\": \\"\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"\\",\\n \\"Path\\": \\"\\",\\n \\"TTL\\": \\"0s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"\\"\\n },\\n \\"WarmupDuration\\": 0\\n }\\n },\\n \\"HealthStatus\\": \\"true\\",\\n \\"HealthCheck\\": \\"true\\",\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"Ports\\": [\\n 80\\n ],\\n \\"PortTrafficPolicyList\\": [\\n {\\n \\"Id\\": 1,\\n \\"ServiceId\\": 1,\\n \\"ServicePort\\": 8080,\\n \\"GatewayUniqueId\\": \\"gw-2837hfd91h34dbg87364g*****\\",\\n \\"TrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"\\",\\n \\"CaCertContent\\": \\"\\",\\n \\"Sni\\": \\"\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"\\",\\n \\"Path\\": \\"\\",\\n \\"TTL\\": \\"0s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"\\"\\n },\\n \\"WarmupDuration\\": 0\\n }\\n },\\n \\"GmtCreate\\": \\"1667460287386\\",\\n \\"GmtModified\\": \\"1667460287386\\"\\n }\\n ],\\n \\"ServiceFQDN\\": \\"\\",\\n \\"ServicePort\\": 0,\\n \\"DnsServerList\\": [\\n \\"1.1.1.1:80\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayServiceDetail', ], - 'UpdateServiceSource' => [ - 'summary' => 'Modifies service sources of a cloud-native gateway. You can modify only Container Service for Kubernetes (ACK) service sources that contain configurations related to Ingress resource monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumerStatus' => [ + 'summary' => 'Updates the status of the consumer on which a gateway performs authentication operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '24909', - 'abilityTreeNodes' => [ - 'FEATUREmseQRG9VI', - ], - ], + 'systemTags' => [], 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service source. Valid values:'."\n" - ."\n" - .'* K8s: ACK cluster.'."\n" - .'* NACOS: Nacos instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'K8s', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service source. Valid values:'."\n" - ."\n" - .'* K8s: ACK cluster.'."\n" - .'* MSE: Nacos instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'K8s', - ], - ], - [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => 'The address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9ad2a0717032427e920754e25b49e3b5', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the service source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '63', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'istio', - ], - ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-cdd1bb9bfb8341e9805f931a3ba1f4c6', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-685f661467b54f48b7b7a76605ce****', 'title' => ''], ], [ - 'name' => 'IngressOptionsRequest', + 'name' => 'Id', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configurations of Ingress resources.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableIngress' => [ - 'description' => 'Specifies whether to enable Ingress.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'IngressClass' => [ - 'description' => 'Specifies whether to monitor Ingress classes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'com.test.xxx', - ], - 'WatchNamespace' => [ - 'description' => 'The namespace whose resources you want to monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'EnableStatus' => [ - 'description' => 'Specifies whether to update the Ingress status.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The consumer ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PathList', + 'name' => 'ConsumerStatus', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'An array of service root paths.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The root path of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/path', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: The consumer is enabled.'."\n" + .'* false: The consumer is disabled.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese.'."\n" - .'* en: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6AB2B0B6-4A86-54E2-A340-FC47A22EE659', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '63', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '56D9E600-6348-4260-B35F-583413F****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateGatewayAuthConsumerStatus', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumerStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AB2B0B6-4A86-54E2-A340-FC47A22EE659\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 63\\n}","type":"json"}]', - 'title' => 'UpdateServiceSource', ], - 'ImportServices' => [ - 'summary' => 'Imports services to a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayCircuitBreakerRule' => [ + 'summary' => 'Updates a gateway circuit breaking rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -46469,512 +31356,492 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '25182', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ServiceList', + 'name' => 'Id', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => 'The group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Ips' => [ - 'description' => 'The IP addresses of the service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.XX.XX', - ], - 'required' => false, - ], - 'ServicePort' => [ - 'title' => '服务的端口', - 'description' => 'The port of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8080', - ], - 'ServiceProtocol' => [ - 'title' => '服务的协议版本', - 'description' => 'The protocol of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GRPC, HTTP', - ], - 'DnsServerList' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'example' => '1.1.1.1:80', - ], - ], - 'SaeAppId' => [ - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => 'DNS', - ], + 'schema' => ['description' => 'The ID of the circuit breaking rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '369', 'title' => ''], ], [ - 'name' => 'SourceType', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'title' => '服务来源', - 'description' => 'The service source. Valid values:'."\n" - ."\n" - .'* MSE: MSE Nacos instance'."\n" - .'* K8s: ACK cluster'."\n" - .'* VIP: fixed address'."\n" - .'* DNS: DNS domain'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'EDAS' => 'EDAS', - 'MSE_ZK' => 'MSE_ZK', - 'SAE' => 'SAE', - 'K8S' => 'K8S', - 'DNS' => 'DNS', - 'VIP' => 'VIP', - 'MSE' => 'MSE', - ], - 'example' => 'DNS', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407', 'title' => ''], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'title' => ''], ], [ - 'name' => 'TlsSetting', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Transport Layer Security (TLS) settings. Valid values:'."\n" - ."\n" - .'* mode: TLS mode'."\n" - .'* certId: certificate ID'."\n" - .'* caCertId: CA certificate ID'."\n" - .'* caCertContent: CA certificate public key'."\n" - .'* sni: service name identification'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mode": "MUTUAL",'."\n" - .' "certId": "1*****-cn-hangzhou",'."\n" - .' "caCertContent": "123",'."\n" - .' "sni": "ceshi"'."\n" - .'}', - ], + 'schema' => ['description' => 'The ID of the route.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '645', 'title' => ''], ], [ - 'name' => 'FcServiceName', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'required' => true, 'example' => 'routeName', 'title' => ''], ], [ - 'name' => 'FcVersion', + 'name' => 'Strategy', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The threshold type.'."\n" + ."\n" + .'0: slow call proportion'."\n" + ."\n" + .'1: failure proportion', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'FcAlias', + 'name' => 'TriggerRatio', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The request percentage that triggers circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'SourceId', + 'name' => 'StatDurationSec', 'in' => 'query', - 'schema' => [ - 'title' => '服务来源ID，指定来源添加服务时使用', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'schema' => ['description' => 'The statistical duration for triggering circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '11', 'title' => ''], + ], + [ + 'name' => 'RecoveryTimeoutSec', + 'in' => 'query', + 'schema' => ['description' => 'The circuit breaking timeout period.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', 'title' => ''], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => ['description' => 'The minimum number of requests to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxAllowedMs', + 'in' => 'query', + 'schema' => ['description' => 'The threshold in slow call proportion mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => ['description' => 'The type of a web fallback behavior.'."\n" + ."\n" + .'0: The specified text is returned'."\n" + ."\n" + .'1: The specified page is displayed', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: normal text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429', 'title' => ''], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP text to be returned.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => ['description' => 'The redirection URL.', 'type' => 'string', 'required' => false, 'example' => 'www.******.com', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disabled.'."\n" + ."\n" + .'1: enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese. en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', 'title' => ''], 'Data' => [ - 'description' => 'The result returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the circuit breaking rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '369', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'title' => ''], + 'RouteId' => ['description' => 'The ID of the route.', 'type' => 'integer', 'format' => 'int64', 'example' => '645', 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'routeName', 'title' => ''], + 'Strategy' => ['description' => 'The threshold type.'."\n" + ."\n" + .'0: slow call proportion.'."\n" + ."\n" + .'1: failure proportion.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TriggerRatio' => ['description' => 'The request percentage that triggers circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'StatDurationSec' => ['description' => 'The statistical duration for triggering circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'RecoveryTimeoutSec' => ['description' => 'The circuit breaking timeout period.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'MinRequestAmount' => ['description' => 'The minimum number of requests to trigger circuit breaking.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxAllowedMs' => ['description' => 'The threshold in slow call proportion mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: standalone.'."\n" + ."\n" + .'1: cluster.'."\n" + ."\n" + .'2: cluster-to-standalone.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: The specified text is returned.'."\n" + ."\n" + .'1: The specified page is displayed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text.'."\n" + ."\n" + .'1: JSON.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '201', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP return text.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirection URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'The custom header. The input is a key-value pair.', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disabled.'."\n" + ."\n" + .'1: enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The IDs of the circuit breaking rules that are used to filter data.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '369', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Id\\": 369,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-c9bc5afd61014165bd58f621b491****\\",\\n \\"RouteId\\": 645,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 201,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 369\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayCircuitBreakerRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'ImportServices', ], - 'UpdateGatewayService' => [ - 'summary' => 'Updates gateways for fixed address services or DNS services.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayConfig' => [ + 'summary' => 'Updates gateway configurations.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '25309', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'abilityTreeCode' => '261694', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '322', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-b525dc1adf3c486ab96224a6346*****', 'title' => ''], ], [ - 'name' => 'GatewayId', + 'name' => 'ConfigName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '501', - ], + 'schema' => ['description' => 'The configuration name of the parameter. Valid values:'."\n" + ."\n" + .'- EnableHttp2'."\n" + ."\n" + .'- DownstreamIdleTime'."\n" + ."\n" + .'- PreserveHeaderFormat'."\n" + ."\n" + .'- UpstreamIdleTimeout'."\n" + ."\n" + .'- EnableXffTrustedCidrs'."\n" + ."\n" + .'- EnableK8sSourceWorkloadFilter', 'type' => 'string', 'required' => true, 'example' => 'EnableK8sSourceWorkloadFilter', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ConfigValue', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The configuration value of the parameter. Examples:'."\n" + ."\n" + .'- EnableHttp2'."\n" + ."\n" + .'```'."\n" + .'true / false'."\n" + .'```'."\n" + ."\n" + .'- DownstreamIdleTime'."\n" + ."\n" + .'```'."\n" + .'15'."\n" + .'```'."\n" + ."\n" + .'- PreserveHeaderFormat'."\n" + ."\n" + .'```'."\n" + .'true / false'."\n" + .'```'."\n" + ."\n" + .'- UpstreamIdleTimeout'."\n" + ."\n" + .'```'."\n" + .'60'."\n" + .'```'."\n" + ."\n" + .'- EnableXffTrustedCidrs'."\n" + ."\n" + .'```json'."\n" + .'{"enable":true,"ipListContent":"192.168.1.0/24'."\n" + .'2.2.2.2"}'."\n" + .'```'."\n" + ."\n" + .'- EnableK8sSourceWorkloadFilter'."\n" + ."\n" + .'```json'."\n" + .' '."\n" + .'{"enable":true,"filterOpt":"EQUAL","labelKey":"key","labelValue":"value"}'."\n" + .'```', 'type' => 'string', 'required' => true, 'example' => '{"enable":true,"filterOpt":"EQUAL","labelKey":"key","labelValue":"value"}', 'title' => ''], ], [ - 'name' => 'IpList', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The language in which you want to display the results. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.1:80', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'ServicePort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '80', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewayConfig', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'UpdateGatewayDomain' => [ + 'summary' => 'Updates an associated domain.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ServiceProtocol', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '35640', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], + ], + 'parameters' => [ + [ + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The protocol type.'."\n" + ."\n" + .'- HTTPS'."\n" + ."\n" + .'- HTTP', 'type' => 'string', 'required' => false, 'example' => 'HTTPS', 'title' => ''], + ], + [ + 'name' => 'MustHttps', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to forcibly redirect requests to HTTPS.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => false, 'example' => '6209108-cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the domain name that you want to update.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '94', 'title' => ''], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', 'title' => ''], ], [ - 'name' => 'TlsSetting', + 'name' => 'Http2', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mode": "MUTUAL",'."\n" - .' "certId": "1*****-cn-hangzhou",'."\n" - .' "caCertContent": "123",'."\n" - .' "sni": "ceshi"'."\n" - .'}', - ], + 'schema' => ['description' => 'Specifies whether to enable `Http2`.'."\n" + ."\n" + .'- `open`: enables `Http2`.'."\n" + ."\n" + .'- `close`: disables `Http2`.'."\n" + ."\n" + .'- `globalConfig`: uses the global configuration.', 'type' => 'string', 'required' => false, 'example' => 'close', 'title' => ''], ], [ - 'name' => 'DnsServerList', + 'name' => 'TlsMax', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'example' => '1.1.1.1:80', - ], - ], + 'schema' => ['description' => 'The maximum Transport Layer Security (TLS) version.', 'type' => 'string', 'required' => false, 'example' => 'TLS 1.3', 'title' => ''], + ], + [ + 'name' => 'TlsMin', + 'in' => 'query', + 'schema' => ['description' => 'The minimum TLS version.', 'type' => 'string', 'required' => false, 'example' => 'TLS 1.0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '322', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'example' => '403', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 322\\n}","type":"json"}]', - 'title' => 'UpdateGatewayService', - ], - 'PullServices' => [ - 'summary' => 'Queries all the microservices of a service source.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 403,\\n \\"Success\\": true,\\n \\"Data\\": 94\\n}","type":"json"}]', + 'title' => 'UpdateGatewayDomain', + 'changeSet' => [ + ['createdAt' => '2026-03-12T02:35:25.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-03-03T08:16:53.000Z', 'description' => 'OpenAPI offline'], ], - 'tags' => [ - 'gateway', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateGatewayFlowRule' => [ + 'summary' => 'Updates a throttling rule of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -46982,235 +31849,184 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '25181', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SourceType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service source.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'k8s' => 'k8s', - 'MSE' => 'MSE', - ], - 'example' => 'K8s', - ], + 'schema' => ['description' => 'The ID of the throttling rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '549', 'title' => ''], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407', 'title' => ''], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-eccf313e2224438ba53d95d039e5****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '48811', 'title' => ''], ], [ - 'name' => 'SourceId', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'title' => '服务来源ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'required' => true, 'example' => 'routeA', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The overall queries per second (QPS) threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: returns the specified text'."\n" + ."\n" + .'1: redirects to the specified page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429', 'title' => ''], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'The returned HTTP text.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => ['description' => 'The redirection URL.', 'type' => 'string', 'required' => false, 'example' => 'www.******.com', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disables the rule.'."\n" + ."\n" + .'1: enables the rule.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want to display the results. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Services' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'SourceId' => [ - 'description' => 'The ID of the service source.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => 'The type of the service source.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'SourceIdList' => [ - 'title' => '归属的服务来源ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '归属的服务来源ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - 'SaeAppId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'NamespaceShowName' => [ - 'description' => 'The alias of the namespace.'."\n", - 'type' => 'string', - 'example' => 'public', - ], + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the throttling rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], + 'RouteId' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48811', 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'routeA', 'title' => ''], + 'Threshold' => ['description' => 'The overall queries per second (QPS) threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'StatDurationMs' => ['description' => 'The duration of the statistics.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: standalone.'."\n" + ."\n" + .'1: cluster.'."\n" + ."\n" + .'2: cluster-to-standalone.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: The specified content is returned.'."\n" + ."\n" + .'1: The specified page is displayed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text'."\n" + ."\n" + .'1: JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '429', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP return text.', 'type' => 'string', 'example' => 'Text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The redirection URL.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'The custom header. The input is a key-value pair.', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: The rule is not enabled.'."\n" + ."\n" + .'1: The rule is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The IDs of the circuit breaking rules that are used to filter data.', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '549', 'title' => ''], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"StatDurationMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"Text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 549\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"test\\",\\n \\"Services\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": \\"1\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"SourceIdList\\": [\\n 100\\n ],\\n \\"SaeAppId\\": \\"\\"\\n }\\n ],\\n \\"NamespaceShowName\\": \\"public\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'PullServices', ], - 'UpdateGatewayServiceCheck' => [ - 'summary' => 'Updates the health check policy of a specified service in a cloud-native gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayIsolationRule' => [ + 'summary' => 'Updates the concurrency rule of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -47218,2247 +32034,1691 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '服务ID', - 'description' => 'The ID of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => 'The ID of the concurrency rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '358', 'title' => ''], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407', 'title' => ''], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-8d410698bd7f4628ab76b*****72dd1d', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], ], [ - 'name' => 'Check', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启健康检查', - 'description' => 'Specifies whether to enable the health check.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '52853', 'title' => ''], ], [ - 'name' => 'ExpectedStatuses', + 'name' => 'RouteName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '正常状态码（健康检查协议为HTTP时必填）', - 'description' => 'The expected status code, which is required if the health check protocol is HTTP.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '用于判断健康检查正常的HTTP状态码：'."\n" - .'- http_2xx: 200'."\n" - .'- http_3xx: 300'."\n" - .'- http_4xx: 400'."\n" - .'- http_5xx: 500', - 'description' => 'The HTTP status code that indicates the normal health check. This parameter is required if the health check protocol is HTTP. Valid values:'."\n" - ."\n" - .'* http\\_2xx: 200'."\n" - .'* http\\_3xx: 300'."\n" - .'* http\\_4xx: 400'."\n" - .'* http\\_5xx: 500'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'required' => true, 'example' => 'routeName', 'title' => ''], ], [ - 'name' => 'Protocol', + 'name' => 'MaxConcurrency', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查协议，目前支持：'."\n" - .'- HTTP'."\n" - .'- TCP', - 'description' => 'The health check protocol. Valid values:'."\n" - ."\n" - .'* HTTP'."\n" - .'* TCP'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The maximum number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Timeout', + 'name' => 'BehaviorType', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查响应超时时间（秒）', - 'description' => 'The timeout period of responses to the health check. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: The specified content is returned.'."\n" + ."\n" + .'1: Redirect to the specified page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'BodyEncoding', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查间隔时间（秒）', - 'description' => 'The interval at which the health check is performed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text'."\n" + ."\n" + .'1: JSON text', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'HealthyThreshold', + 'name' => 'ResponseStatusCode', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查健康阈值', - 'description' => 'The healthy threshold of the health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429', 'title' => ''], ], [ - 'name' => 'UnhealthyThreshold', + 'name' => 'ResponseContentBody', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查不健康阈值', - 'description' => 'The unhealthy threshold of the health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The HTTP text to be returned.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], ], [ - 'name' => 'HttpPath', + 'name' => 'ResponseRedirectUrl', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查路径（健康检查协议为HTTP时必填）', - 'description' => 'The health check path, which is required if the health check protocol is HTTP.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/healthz', - ], + 'schema' => ['description' => 'The URL to be redirected to.', 'type' => 'string', 'required' => false, 'example' => 'www.******.com', 'title' => ''], ], [ - 'name' => 'HttpHost', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查域名', - 'description' => 'The health check domain name, which is optional if the health check protocol is HTTP.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disable'."\n" + ."\n" + .'1: enable', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want to display the results. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '62CBFCB8-DDC6-588C-BF1B-88828AF*****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', 'title' => ''], 'Data' => [ - 'description' => 'The service ID of the operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the concurrency rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '358', 'title' => ''], + 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14407', 'title' => ''], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', 'title' => ''], + 'RouteId' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '52853', 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'routeName', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The maximum number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'LimitMode' => ['description' => 'The threshold conversion mode.'."\n" + ."\n" + .'0: standalone'."\n" + ."\n" + .'1: cluster'."\n" + ."\n" + .'2: cluster-to-standalone', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BehaviorType' => ['description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: The specified content is returned.'."\n" + ."\n" + .'1: Redirect the specified page.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BodyEncoding' => ['description' => 'The encoding type.'."\n" + ."\n" + .'0: plain text'."\n" + ."\n" + .'1: JSON text', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResponseStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '429', 'title' => ''], + 'ResponseContentBody' => ['description' => 'The HTTP text to be returned.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'ResponseRedirectUrl' => ['description' => 'The URL that is redirected to.', 'type' => 'string', 'example' => 'www.******.com', 'title' => ''], + 'ResponseAdditionalHeaders' => ['description' => 'The custom header. The input is a key-value pair.', 'type' => 'string', 'example' => 'key=value', 'title' => ''], + 'Enable' => ['description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'0: disable'."\n" + ."\n" + .'1: enable', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IdList' => [ + 'title' => '', + 'description' => 'The IDs of the circuit breaking rules that are used to filter data.', + 'type' => 'array', + 'items' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '358', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayIsolationRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"62CBFCB8-DDC6-588C-BF1B-88828AF*****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 12\\n}","type":"json"}]', - 'title' => 'UpdateGatewayServiceCheck', ], - 'UpdateGatewayRouteAuth' => [ - 'summary' => 'Updates the authentication configurations of a route.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayName' => [ + 'summary' => 'Updates the name of a gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '66628', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], + ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '109', - ], - ], - [ - 'name' => 'GatewayId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '102', - ], + 'schema' => ['description' => 'The name of the gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demo-test', 'title' => ''], ], [ - 'name' => 'AuthJSON', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The authentication configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The authentication type. If an empty string is passed, no authentication type is available. Valid values:'."\n" - ."\n" - .'* JWT'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-1cef54brvecdb419fb264d4f9b8c', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8C95711F-E702-5395-BFAA-21BA946CDE47'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C95711F-E702-5395-BFAA-21BA946CDE47\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewayName', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 123\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteAuth', ], - 'ListGatewayAuthConsumerResource' => [ - 'summary' => 'Queries the list of authorized resources for the consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayOption' => [ + 'summary' => 'Updates the configurations of a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], - ], - [ - 'name' => 'ConsumerId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'ResourceStatus', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource authorization status. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '421', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'GatewayOption', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'style' => 'json', + 'schema' => ['description' => 'The detailed configurations of the gateway.'."\n" + ."\n" + .'* **TraceDetails**: the sampling description of Managed Service for OpenTelemetry. Content: TraceEnabled indicates whether Managed Service for OpenTelemetry is activated. Sample indicates the sampling rate of Managed Service for OpenTelemetry.'."\n" + .'* **LogConfigDetails**: the description of Simple Log Service. Content: LogEnabled indicates whether Simple Log Service is activated. ProjectName indicates the Simple Log Service project to which logs are delivered. LogStoreName indicates the name of the Logstore.'."\n" + .'* **EnableHardwareAcceleration**: indicates whether hardware acceleration is enabled.'."\n" + .'* **DisableHttp2Alpn**: indicates whether the HTTP/2 protocol is disabled.'."\n" + .'* **EnableWaf**: indicates whether Web Application Firewall (WAF) is enabled.'."\n", 'required' => false, '$ref' => '#/components/schemas/GatewayOption', 'title' => '', 'example' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c4****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the authorized resource for the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ConsumerId' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RouteId' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3091', - ], - 'RouteName' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceStatus' => [ - 'description' => 'The resource authorization status. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '124D02EB-DBDD-534D-A701-B4A95D3D****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The data returned.'."\n", 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': True}, \'TraceDetails\': {\'Sample\': 17, \'TraceEnabled\': True}}', '$ref' => '#/components/schemas/GatewayOption', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"ConsumerId\\": 2,\\n \\"RouteId\\": 3091,\\n \\"RouteName\\": \\"test\\",\\n \\"ResourceStatus\\": true,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayAuthConsumerResource', - ], - 'UpdateGatewayAuthConsumer' => [ - 'summary' => 'Updates the consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'gateway', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"124D02EB-DBDD-534D-A701-B4A95D3D****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TraceDetails\\": {\\n \\"TraceEnabled\\": true,\\n \\"Sample\\": 10,\\n \\"TraceType\\": \\"XTRACE\\",\\n \\"ServiceId\\": 10458,\\n \\"ServicePort\\": \\"80\\"\\n },\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"project\\",\\n \\"LogStoreName\\": \\"name\\"\\n },\\n \\"EnableHardwareAcceleration\\": true,\\n \\"DisableHttp2Alpn\\": true,\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayOption', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayOption', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'UpdateGatewayRoute' => [ + 'summary' => 'Updates a routing rule for a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25973', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], + ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '501', 'title' => ''], + ], + [ + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'deprecated' => true, 'title' => '', 'required' => false, 'example' => 'route-web'], + ], + [ + 'name' => 'RouteOrder', + 'in' => 'query', + 'schema' => ['description' => 'The sequence number of the route.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Predicates', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', + 'description' => 'The route matching conditions.', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The path matching.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The route path.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], + 'Type' => ['description' => 'The matching type.', 'type' => 'string', 'required' => false, 'example' => 'PRE', 'title' => ''], + 'IgnoreCase' => ['description' => 'Specifies whether to ignore case sensitivity.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '', + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.', + 'type' => 'array', + 'items' => ['description' => 'The method.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HeaderPredicates' => [ + 'description' => 'The information about header matching.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The request header key.', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''], + 'Value' => ['description' => 'The corresponding value.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], + 'Type' => ['description' => 'The matching type.', 'type' => 'string', 'required' => false, 'example' => 'PRE', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'QueryPredicates' => [ + 'description' => 'The information about parameter matching.', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'userid', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The match type.', 'type' => 'string', 'required' => false, 'example' => 'PRE', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => 'gw-90392d768a3847a7b804c505254d****', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EncodeType', + 'name' => 'Services', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The encryption type. Valid values:'."\n" - ."\n" - .'* RSA'."\n" - .'* OCT'."\n", - 'type' => 'string', + 'description' => 'The service that you want to associate with the gateway. This parameter is required if the Route Point parameter is set to Single Service, Multiple Services, or Label routing.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of services.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'Percent' => ['description' => 'The traffic weight of the service of a specific version, in percentage. This parameter is required if the Route Point parameter is set to Multiple Services or Label routing.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'Version' => ['description' => 'The service version. This parameter is required only if the Route Point parameter is set to Label routing.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'web', 'title' => ''], + 'SourceType' => ['description' => 'The type of the source.', 'type' => 'string', 'required' => false, 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace to which the service belongs.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'GroupName' => ['description' => 'The name of the group to which the service belongs.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'AgreementType' => ['description' => 'The Protocol Type.', 'type' => 'string', 'required' => false, 'example' => 'DUBBO'."\n", 'title' => ''], + 'HttpDubboTranscoder' => [ + 'description' => 'The Dubbo protocol converter.', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'The Dubbo service name.', 'type' => 'string', 'required' => false, 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', 'title' => ''], + 'DubboServiceVersion' => ['description' => 'The Dubbo service version.', 'type' => 'string', 'required' => false, 'example' => '0.0.0', 'title' => ''], + 'DubboServiceGroup' => ['description' => 'The Dubbo service group.', 'type' => 'string', 'required' => false, 'example' => 'service name', 'title' => ''], + 'MothedMapList' => [ + 'description' => 'The Dubbo forwarding rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The method mapping object.', + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'The Dubbo method name.', 'type' => 'string', 'required' => false, 'example' => 'sayHello', 'title' => ''], + 'HttpMothed' => ['description' => 'The HTTP method.'."\n" + ."\n" + .'> Supported HTTP method parameter values.'."\n" + .'>'."\n" + .'> - ALL\\_GET.'."\n" + .'>'."\n" + .'> - ALL\\_POST.'."\n" + .'>'."\n" + .'> - ALL\\_PUT.'."\n" + .'>'."\n" + .'> - ALL\\_DELETE.'."\n" + .'>'."\n" + .'> - ALL\\_PATCH.', 'type' => 'string', 'required' => false, 'example' => 'ALL_GET', 'title' => ''], + 'Mothedpath' => ['description' => 'The path that is used to match a method.', 'type' => 'string', 'required' => false, 'example' => '/mytestzbk/sayhello'."\n", 'title' => ''], + 'PassThroughAllHeaders' => ['description' => 'The pass-through type of the header.'."\n" + ."\n" + .'> Enumeration values for pass-through types.'."\n" + .'>'."\n" + .'> - PASS\\_ALL: All headers are passed through.'."\n" + .'>'."\n" + .'> - PASS\\_NOT: All headers are not passed through.'."\n" + .'>'."\n" + .'> - PASS\\_ASSIGN: Specified headers are passed through.', 'type' => 'string', 'required' => false, 'example' => 'PASS_NOT'."\n", 'title' => ''], + 'PassThroughList' => [ + 'description' => 'The headers that are passed through.', + 'type' => 'array', + 'items' => ['description' => 'The header value that is passed through.', 'type' => 'string', 'required' => false, 'example' => 'x-forward'."\n", 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ParamMapsList' => [ + 'description' => 'The information about parameter mappings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter mapping object.', + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => 'The input parameter position.'."\n" + ."\n" + .'> Enumeration values for input parameter positions.'."\n" + .'>'."\n" + .'> - Request parameter: `ALL_QUERY_PARAMETER`'."\n" + .'>'."\n" + .'> - Request header: `ALL_HEADER`'."\n" + .'>'."\n" + .'> - URI of the request: `ALL_PATH`'."\n" + .'>'."\n" + .'> - Request body: `ALL_BODY`', 'type' => 'string', 'required' => false, 'example' => 'ALL_QUERY_PARAMETER'."\n", 'title' => ''], + 'ExtractKey' => ['description' => 'The key of the input parameter that is extracted.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'MappingType' => ['description' => 'The type of the backend service parameter.', 'type' => 'string', 'required' => false, 'example' => 'java.lang.String', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ServicePort' => ['description' => 'The Dubbo port number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20880', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'RSA', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Jwks', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The JWT public key. The JSON format is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', - ], + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '139', 'title' => ''], ], [ - 'name' => 'TokenName', + 'name' => 'DestinationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], + 'schema' => ['description' => 'The destination service type.', 'type' => 'string', 'required' => false, 'example' => 'Mock', 'title' => ''], ], [ - 'name' => 'TokenPass', + 'name' => 'DirectResponseJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to enable pass-through.'."\n", - 'type' => 'boolean', + 'description' => 'The Mock content.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The Mock return code.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''], + 'Body' => ['description' => 'The return value.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], + ], 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TokenPosition', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392a2c4', 'title' => ''], ], [ - 'name' => 'TokenPrefix', + 'name' => 'DomainIdListJSON', 'in' => 'query', - 'schema' => [ - 'description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer ', - ], + 'schema' => ['description' => 'The associated domain name.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '[90]', 'title' => ''], ], [ - 'name' => 'KeyName', + 'name' => 'RedirectJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the key used for JWT-based identity authentication.'."\n", - 'type' => 'string', + 'description' => 'The redirection.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '302', 'title' => ''], + 'Host' => ['description' => 'The hostname to be redirected to.', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''], + 'Path' => ['description' => 'The path to be redirected to.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], + ], 'required' => false, - 'example' => 'iss', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'KeyValue', + 'name' => 'EnableWaf', 'in' => 'query', - 'schema' => [ - 'description' => 'The value of the key used for JWT-based identity authentication.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], + 'schema' => ['description' => 'Deprecated. Use UpdateGatewayRouteWafStatus to update the WAF status of a route.', 'type' => 'boolean', 'deprecated' => true, 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Description', + 'name' => 'Fallback', 'in' => 'query', + 'schema' => ['description' => 'Indicates whether to enable the Fallback service.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'FallbackServices', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the consumer.'."\n", - 'type' => 'string', + 'description' => 'The Fallback services.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data object.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'Percent' => ['description' => 'The weight in the form of a percentage value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'Version' => ['description' => 'The version of the service.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'SourceType' => ['description' => 'The type of the source.', 'type' => 'string', 'required' => false, 'example' => 'MSE', 'title' => ''], + 'Namespace' => ['description' => 'The namespace in which the service resides.', 'type' => 'string', 'required' => false, 'example' => 'Namespace'."\n", 'title' => ''], + 'GroupName' => ['description' => 'The name of the group to which the service belongs.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'AgreementType' => ['description' => 'The Protocol Type.', 'type' => 'string', 'required' => false, 'example' => 'DUBBO'."\n", 'title' => ''], + 'ServicePort' => ['description' => 'The service port number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8848', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'Description'."\n", + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '63', - ], + 'schema' => ['description' => 'The route description', 'type' => 'string', 'example' => 'a route for xxx', 'title' => '', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'Data structure', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID', 'type' => 'string', 'example' => '73785414-2C5B-5E28-BD91-B2C742269C48'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The call was successful.'."\n" + ."\n" + .'- `false`: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The data.', 'type' => 'integer', 'format' => 'int64', 'example' => '337', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73785414-2C5B-5E28-BD91-B2C742269C48\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 337,\\n \\"ErrorCode\\": \\"NoPermission\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRoute', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 2\\n}","type":"json"}]', - 'title' => 'UpdateGatewayAuthConsumer', + 'translator' => 'manual', ], - 'ListGatewayRouteOnAuth' => [ - 'summary' => 'Queries a list of routes for which authentication is enabled.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteAuth' => [ + 'summary' => 'Updates the authentication configurations of a route.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The route ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '109', 'title' => ''], + ], + [ + 'name' => 'GatewayId', 'in' => 'query', + 'schema' => ['description' => 'The gateway ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102', 'title' => ''], + ], + [ + 'name' => 'AuthJSON', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The authentication method. Valid values:'."\n" - ."\n" - .'* JWT'."\n", - 'type' => 'string', + 'description' => 'The authentication configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The authentication type. If an empty string is passed, no authentication type is available. Valid values:'."\n" + ."\n" + .'* JWT'."\n", 'type' => 'string', 'required' => false, 'example' => 'JWT', 'title' => ''], + ], 'required' => true, - 'example' => 'JWT', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => 'RestResult>', + 'description' => 'RestResult\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'example' => 'ceshi', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'string', - 'example' => '399', - ], - 'RoutePredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/api', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => '123.com', - ], - 'DomainIdList' => [ - 'description' => 'The domain IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'DomainNameList' => [ - 'description' => 'The domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'DynamicCode' => ['title' => '', 'description' => 'The dynamic part in the error message.'."\n", 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.', 'title' => ''], + 'Data' => ['description' => 'The route ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 123\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteAuth', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 12,\\n \\"Name\\": \\"ceshi\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": \\"399\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/api\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"123.com\\",\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListGatewayRouteOnAuth', ], - 'ListGatewayAuthConsumer' => [ - 'summary' => 'Queries the list of consumers on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteCORS' => [ + 'summary' => 'Modifies the cross-origin resource sharing (CORS) policy of a route.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'abilityTreeCode' => '101484', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0fe488252dc44d55a9dd57875193****', - ], - ], - [ - 'name' => 'Name', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the consumer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the associated record.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '55', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The authentication type. Valid values:'."\n" - ."\n" - .'* JWT'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], + 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85', 'title' => ''], ], [ - 'name' => 'ConsumerStatus', + 'name' => 'CorsJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The status of the consumer. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', + 'description' => 'The information about the CORS policy.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the policy.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], + 'AllowOrigins' => ['description' => 'The origins from which access is allowed.', 'type' => 'string', 'required' => false, 'example' => 'https://api.aliyun-inc.com/', 'title' => ''], + 'AllowMethods' => ['description' => 'The HTTP methods allowed.', 'type' => 'string', 'required' => false, 'example' => 'GET,POST', 'title' => ''], + 'AllowHeaders' => ['description' => 'The request headers allowed.', 'type' => 'string', 'required' => false, 'example' => 'content-type', 'title' => ''], + 'ExposeHeaders' => ['description' => 'The response headers allowed.', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], + 'TimeUnit' => ['description' => 'The unit of time.', 'type' => 'string', 'required' => false, 'example' => 'h', 'title' => ''], + 'UnitNum' => ['description' => 'The value of time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24', 'title' => ''], + 'AllowCredentials' => ['description' => 'The credentials allowed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-f70a6ddf2f0941a2bb997b2d16028f37', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. In compliance with [RFC 7231](https://tools.ietf.org/html/rfc7231), the backend service must return a response based on the language used by the user.'."\n" + ."\n" + .'- No default value.'."\n" + ."\n" + .'- zh-CN: Chinese'."\n" + ."\n" + .'- en-US: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'dc63-465d-8ef5-20dc18af****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name of the consumer.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ConsumerStatus' => [ - 'description' => 'The status of the consumer. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PrimaryUser' => [ - 'description' => 'The creator.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'Type' => [ - 'description' => 'The authentication type. Valid values:'."\n" - ."\n" - .'* JWT'."\n", - 'type' => 'string', - 'example' => 'JWT', - ], - 'Description' => [ - 'description' => 'The description of the consumer.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '41BE990E-44E4-5ED3-AEEB-A276941B1854'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. ', 'title' => ''], + 'Code' => ['description' => 'The status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The data structure.', 'type' => 'integer', 'format' => 'int64', 'example' => '618', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41BE990E-44E4-5ED3-AEEB-A276941B1854\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. \\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 618\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteCORS', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteCORS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"ConsumerStatus\\": true,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"Type\\": \\"JWT\\",\\n \\"Description\\": \\"描述\\",\\n \\"GmtCreate\\": \\"2021-09-13 19:24:23\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayAuthConsumer', ], - 'UpdateGatewayAuthConsumerResource' => [ - 'summary' => 'Updates a list of resources on which permissions are granted to a gateway authentication consumer.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteHTTPRewrite' => [ + 'summary' => 'Updates the rewrite policy of a route for a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'abilityTreeCode' => '59359', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], + 'schema' => ['description' => 'The ID of the route.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '238', 'title' => ''], ], [ - 'name' => 'ConsumerId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The gateway authentication consumer ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '430', 'title' => ''], ], [ - 'name' => 'ResourceList', + 'name' => 'HttpRewriteJSON', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'description' => 'The gateway authentication consumer ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resources.'."\n", - 'type' => 'object', - 'properties' => [ - 'RouteId' => [ - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '7816', - ], - 'RouteName' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'helo', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The information about the rewrite policy. The JSON format is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"pathType":"PRE","path":"/","status":"off"}', 'title' => ''], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-90392d768a3847a7b804c505254da96d', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether the list of the resources was updated. Valid values:'."\n" - ."\n" - .'* true: The list of the resources was updated.'."\n" - .'* false: The list of the resources was not updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AE60DA1E-B234-5105-897B-68372453A5A2'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The return value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '411', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE60DA1E-B234-5105-897B-68372453A5A2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 411\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteHTTPRewrite', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteHTTPRewrite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateGatewayAuthConsumerResource', ], - 'UpdateGatewayAuthConsumerStatus' => [ - 'summary' => 'Updates the status of the consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteHeaderOp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '72158', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], + ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-685f661467b54f48b7b7a76605ce****', - ], + 'schema' => ['description' => 'The ID of the record.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '411'], ], [ - 'name' => 'Id', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The consumer ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '324'], ], [ - 'name' => 'ConsumerStatus', + 'name' => 'HeaderOpJSON', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the consumer. Valid values:'."\n" - ."\n" - .'* true: The consumer is enabled.'."\n" - .'* false: The consumer is disabled.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The description of user header settings.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"status\\":\\"on\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Update\\",\\"key\\":\\"hosts\\",\\"value\\":\\"test.com\\"}]}'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-6bdc977deda44bf589c49d063b4c2d1d'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '56D9E600-6348-4260-B35F-583413F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7C8CB294-BED8-5F32-A416-7517725E8F27'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '666'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateGatewayAuthConsumerStatus', - ], - 'AddGatewayAuthConsumer' => [ - 'summary' => 'Adds a consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C8CB294-BED8-5F32-A416-7517725E8F27\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 666\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteHeaderOp', + 'summary' => 'Modifies the header configuration policy of a route.', + 'changeSet' => [ + ['createdAt' => '2022-11-15T07:39:53.000Z', 'description' => 'Request parameters changed'], ], - 'tags' => [ - 'gateway', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteHeaderOp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'UpdateGatewayRouteRetry' => [ + 'summary' => 'Modifies the retry policy for a gateway route.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '114051', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['description' => 'The ID of the associated record.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '508', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the consumer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '501', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'RetryJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The authentication type. Valid values:'."\n" - ."\n" - .'* JWT'."\n", - 'type' => 'string', + 'description' => 'The retry policy.', + 'type' => 'object', + 'properties' => [ + 'Attempts' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'RetryOn' => [ + 'description' => 'The conditions that trigger a retry.', + 'type' => 'array', + 'items' => ['description' => 'The specific condition.', 'type' => 'string', 'required' => false, 'example' => '5xx', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HttpCodes' => [ + 'description' => 'The HTTP status codes.', + 'type' => 'array', + 'items' => ['description' => 'The HTTP status code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'The status of the retry policy.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], + ], 'required' => true, - 'example' => 'JWT', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EncodeType', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The encryption type. Valid values:'."\n" - ."\n" - .'* RSA'."\n" - .'* OCT'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RSA', - ], + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1d10a', 'title' => ''], ], [ - 'name' => 'Jwks', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The JWT public key. The JSON format is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], - [ - 'name' => 'TokenName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The data returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '640', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'TokenPass', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable pass-through.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9297B27D-D932-5E9F-93B9-99D6C5F3A879\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 640\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteRetry', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'TokenPosition', - 'in' => 'query', - 'schema' => [ - 'description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteRetry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], - [ - 'name' => 'TokenPrefix', - 'in' => 'query', - 'schema' => [ - 'description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer ', - ], + ], + ], + 'UpdateGatewayRouteTimeout' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '114050', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], + ], + 'parameters' => [ [ - 'name' => 'KeyName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the key used for JWT-based identity authentication.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'iss', - ], + 'schema' => ['description' => 'The ID of the associated record.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '567'], ], [ - 'name' => 'KeyValue', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The value of the key used for JWT-based identity authentication.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85'], ], [ - 'name' => 'Description', + 'name' => 'TimeoutJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the consumer.'."\n", - 'type' => 'string', + 'description' => 'The timeout period.'."\n", + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['description' => 'The value of the timeout period.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'TimeUnit' => ['description' => 'The unit of time. A value of s indicates seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => 's'], + 'Status' => ['description' => 'The status of the policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'off'], + ], 'required' => false, - 'example' => 'description', ], ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-533290d279c1405f9628c64f7c8272ee'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the `%s` variable in the `ErrMessage` parameter.'."\n" - ."\n" - .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5359729E-A059-5942-98AF-E981E89C99FA'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => 'The return value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '400'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5359729E-A059-5942-98AF-E981E89C99FA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 400\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteTimeout', + 'summary' => 'Modifies the timeout policy of a route.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteTimeout', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 2\\n}","type":"json"}]', - 'title' => 'AddGatewayAuthConsumer', ], - 'DeleteGatewayAuthConsumerResource' => [ - 'summary' => 'Deletes resource permissions from the consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteWafStatus' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '131361', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], + ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", - ], + 'schema' => ['description' => 'The ID of the route.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '645'], ], [ - 'name' => 'ConsumerId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The consumer ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****'], ], [ - 'name' => 'IdList', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the authorized resources that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3,4', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'EnableWaf', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the route.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => 'The name of the route.'."\n", 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'GatewayId' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '102'], + 'DefaultServiceId' => ['description' => 'The default service ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DefaultServiceName' => ['description' => 'The default service name.'."\n", 'type' => 'string', 'example' => 'test'], + 'Status' => ['description' => 'The status of the route.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-01-26T09:52:41.000+0000'], + 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2022-02-24T06:08:29.230+0000'], + 'RouteOrder' => ['description' => 'The sequence number of the route.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Predicates' => ['description' => 'The matching rule.'."\n", 'type' => 'string', 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}'], + 'RoutePredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The path.'."\n", 'type' => 'string', 'example' => '/zookeeper/mmgw/unlogined/common.getBu'], + 'Type' => ['description' => 'The matching type.'."\n", 'type' => 'string', 'example' => 'PRE'], + 'IgnoreCase' => ['description' => 'Indicates whether case sensitivity is ignored.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The method.'."\n", 'type' => 'string', 'example' => 'GET'], + ], + 'HeaderPredicates' => [ + 'description' => 'The information about matching based on request headers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the request header.'."\n", 'type' => 'string', 'example' => 'alibo'], + 'Value' => ['description' => 'The value of the request header.'."\n", 'type' => 'string', 'example' => '200'], + 'Type' => ['description' => 'The matching type.'."\n", 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + 'QueryPredicates' => [ + 'description' => 'The parameter matching rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'instanceId'], + 'Value' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => 'test'], + 'Type' => ['description' => 'The type.'."\n", 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + ], + ], + 'DomainId' => ['description' => 'The domain ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '235'], + 'DomainName' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'nbhamster.com'], + 'Services' => ['description' => 'The information about services.'."\n", 'type' => 'string', 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]'], + 'RouteServices' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The ID of the service.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '547'], + 'ServiceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'b-service'], + 'Percent' => ['description' => 'The weight.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'Version' => ['description' => 'The version of the service.'."\n", 'type' => 'string', 'example' => 'v1'], + 'Name' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'test-aixue-gray'], + 'SourceType' => ['description' => 'The source type of the service.'."\n", 'type' => 'string', 'example' => 'K8s'], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => 'The name of the group to which the service belongs.'."\n", 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + ], + ], + ], + 'HTTPRewrite' => [ + 'description' => 'The information about the rewrite policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The HTTP status.'."\n", 'type' => 'string', 'example' => 'off'], + 'Path' => ['description' => 'The HTTP request path.'."\n", 'type' => 'string', 'example' => '/test/client'], + 'Host' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'aliyuncs.com'], + 'PathType' => ['description' => 'The path type of the HTTP request.'."\n", 'type' => 'string', 'example' => 'PRE'], + 'Pattern' => ['description' => 'The matching pattern.'."\n", 'type' => 'string', 'example' => '/test'], + 'Substitution' => ['description' => 'The replacement.'."\n", 'type' => 'string', 'example' => 'test'], + ], + ], + 'HeaderOp' => [ + 'description' => 'The header settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.'."\n", 'type' => 'string', 'example' => 'off'], + 'HeaderOpItems' => [ + 'description' => 'The policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'DirectionType' => ['description' => 'The request or response.'."\n", 'type' => 'string', 'example' => 'Response'], + 'OpType' => ['description' => 'The operation type.'."\n", 'type' => 'string', 'example' => 'Add'], + 'Key' => ['description' => 'The header key.'."\n", 'type' => 'string', 'example' => 'debug'], + 'Value' => ['description' => 'The header value.'."\n", 'type' => 'string', 'example' => 'test'], + ], + ], + ], + ], + ], + 'DestinationType' => ['description' => 'The destination service type.'."\n", 'type' => 'string', 'example' => 'Single'], + 'DirectResponse' => [ + 'description' => 'The information about service mocking.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The return value.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Body' => ['description' => 'The mock return value.'."\n", 'type' => 'string', 'example' => '[{\\"key\\":\\"h68d13466.sqa.eu95\\",\\"dims\\":\\"groupName=All}]'], + ], + ], + 'Cors' => [ + 'description' => 'The configuration for cross-origin resource sharing (CORS).'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.'."\n", 'type' => 'string', 'example' => 'off'], + 'AllowOrigins' => ['description' => 'The origins allowed.'."\n", 'type' => 'string', 'example' => '*'], + 'AllowMethods' => ['description' => 'The methods allowed.'."\n", 'type' => 'string', 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH'], + 'AllowHeaders' => ['description' => 'The headers allowed.'."\n", 'type' => 'string', 'example' => '*'], + 'ExposeHeaders' => ['description' => 'The response headers.'."\n", 'type' => 'string', 'example' => '*'], + 'TimeUnit' => ['description' => 'The time unit.'."\n", 'type' => 'string', 'example' => 's'], + 'UnitNum' => ['description' => 'The unit number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AllowCredentials' => ['description' => 'The credentials allowed.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'Timeout' => [ + 'description' => 'The timeout configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['description' => 'The unit number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TimeUnit' => ['description' => 'The time unit.'."\n", 'type' => 'string', 'example' => 's'], + 'Status' => ['description' => 'The status.'."\n", 'type' => 'string', 'example' => 'off'], + ], + ], + 'Retry' => [ + 'description' => 'The retry configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Attempts' => ['description' => 'The number of retries allowed for a request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RetryOn' => [ + 'description' => 'The retry condition.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The retry condition.'."\n", 'type' => 'string', 'example' => '5xx'], + ], + 'HttpCodes' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '500'], + ], + 'Status' => ['description' => 'The retry status.'."\n", 'type' => 'string', 'example' => 'on'], + ], + ], + 'DomainIdList' => [ + 'description' => 'The list of domain IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The list of domain IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'DomainNameList' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The domain names.'."\n", 'type' => 'string', 'example' => 'test.com'], + ], + 'Redirect' => [ + 'description' => 'The configuration of the redirection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Host' => ['description' => 'The hostname.'."\n", 'type' => 'string', 'example' => 'ww.al.c'], + 'Path' => ['description' => 'The path.'."\n", 'type' => 'string', 'example' => '/'], + ], + ], + 'EnableWaf' => ['description' => 'Indicates whether WAF is activated.'."\n", 'type' => 'boolean', 'example' => '0'], + ], ], ], ], @@ -49466,720 +33726,451 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteGatewayAuthConsumerResource', - ], - 'UpdateGatewayAuthConsumerResourceStatus' => [ - 'summary' => 'Updates the resource authorization status for the consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 102,\\n \\"DefaultServiceId\\": 1,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2022-01-26T09:52:41.000+0000\\",\\n \\"GmtModified\\": \\"2022-02-24T06:08:29.230+0000\\",\\n \\"RouteOrder\\": 1,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/metas\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":false}}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/zookeeper/mmgw/unlogined/common.getBu\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"alibo\\",\\n \\"Value\\": \\"200\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"instanceId\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"nbhamster.com\\",\\n \\"Services\\": \\"[{\\\\\\\\\\\\\\"Percent\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"ServiceId\\\\\\\\\\\\\\":126}]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 547,\\n \\"ServiceName\\": \\"b-service\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"test-aixue-gray\\",\\n \\"SourceType\\": \\"K8s\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\"\\n }\\n ],\\n \\"HTTPRewrite\\": {\\n \\"Status\\": \\"off\\",\\n \\"Path\\": \\"/test/client\\",\\n \\"Host\\": \\"aliyuncs.com\\",\\n \\"PathType\\": \\"PRE\\",\\n \\"Pattern\\": \\"/test\\",\\n \\"Substitution\\": \\"test\\"\\n },\\n \\"HeaderOp\\": {\\n \\"Status\\": \\"off\\",\\n \\"HeaderOpItems\\": [\\n {\\n \\"DirectionType\\": \\"Response\\",\\n \\"OpType\\": \\"Add\\",\\n \\"Key\\": \\"debug\\",\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n },\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"[{\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h68d13466.sqa.eu95\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dims\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"groupName=All}]\\"\\n },\\n \\"Cors\\": {\\n \\"Status\\": \\"off\\",\\n \\"AllowOrigins\\": \\"*\\",\\n \\"AllowMethods\\": \\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\n \\"AllowHeaders\\": \\"*\\",\\n \\"ExposeHeaders\\": \\"*\\",\\n \\"TimeUnit\\": \\"s\\",\\n \\"UnitNum\\": 1,\\n \\"AllowCredentials\\": true\\n },\\n \\"Timeout\\": {\\n \\"UnitNum\\": 10,\\n \\"TimeUnit\\": \\"s\\",\\n \\"Status\\": \\"off\\"\\n },\\n \\"Retry\\": {\\n \\"Attempts\\": 1,\\n \\"RetryOn\\": [\\n \\"5xx\\"\\n ],\\n \\"HttpCodes\\": [\\n \\"500\\"\\n ],\\n \\"Status\\": \\"on\\"\\n },\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"ww.al.c\\",\\n \\"Path\\": \\"/\\"\\n },\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteWafStatus', + 'summary' => 'Updates the WAF status of a route.', + 'changeSet' => [ + ['createdAt' => '2022-11-15T07:39:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-23T09:08:21.000Z', 'description' => 'OpenAPI offline'], ], - 'tags' => [ - 'gateway', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteWafStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], + ], + 'UpdateGatewayService' => [ + 'summary' => 'Edit a gateway service (applicable only to fixed address services or DNS domain name services)', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25309', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], + ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-2a99625886d54722be94d92e9a69****', - ], + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => false, 'example' => '322', 'title' => ''], ], [ - 'name' => 'ConsumerId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'The gateway ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '501', 'title' => ''], ], [ - 'name' => 'IdList', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of IDs of the authorized resources that a user wants to update.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3,4', - ], + 'schema' => ['description' => 'The service name. This parameter is deprecated and cannot be modified. The value of this parameter must be the same as the current service name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ResourceStatus', + 'name' => 'IpList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The resource authorization status. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + 'description' => 'The address list of fixed address services or domain name list of Domain Name System (DNS) services.', + 'type' => 'array', + 'items' => ['description' => 'The address of a fixed address service or domain name of a DNS service.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1:80', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ServicePort', + 'in' => 'query', + 'schema' => ['description' => 'The service port. Specify this parameter for DNS services.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'ServiceProtocol', + 'in' => 'query', + 'schema' => ['description' => 'The service protocol.'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'- HTTPS'."\n" + ."\n" + .'- HTTP2'."\n" + ."\n" + .'- GRPC'."\n" + ."\n" + .'- DUBBO', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.', 'type' => 'string', 'required' => false, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', 'title' => ''], + ], + [ + 'name' => 'TlsSetting', + 'in' => 'query', + 'schema' => ['description' => 'The Transport Layer Security (TLS) settings. Valid values:'."\n" + ."\n" + .'- mode: TLS mode'."\n" + ."\n" + .'- certId: certificate ID'."\n" + ."\n" + .'- caCertId: CA certificate ID'."\n" + ."\n" + .'- caCertContent: CA certificate public key'."\n" + ."\n" + .'- sni: service name identification', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mode": "MUTUAL",'."\n" + .' "certId": "1*****-cn-hangzhou",'."\n" + .' "caCertContent": "123",'."\n" + .' "sni": "ceshi"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'DnsServerList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The DNS server addresses (IP address+port number).', 'type' => 'string', 'example' => '1.1.1.1:80', 'title' => '', 'required' => false], + 'description' => 'The list of Domain Name System (DNS) servers (for DNS domain name services only).', + 'title' => '', 'required' => false, - 'example' => 'zh', + 'example' => '', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the `%s` variable in the `ErrMessage` parameter.'."\n" - ."\n" - .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether the execution was successful. Valid values:'."\n" - ."\n" - .'* true: The execution was successful.'."\n" - .'* false: The execution failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '322', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 322\\n}","type":"json"}]', + 'title' => 'UpdateGatewayService', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateGatewayAuthConsumerResourceStatus', ], - 'DeleteGatewayAuthConsumer' => [ - 'summary' => 'Deletes a consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayServiceCheck' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => '12'], + ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['title' => '', 'description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gw-8d410698bd7f4628ab76b*****72dd1d'], ], [ - 'name' => 'Id', + 'name' => 'Check', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the consumer on which the gateway performs authentication operations.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the health check.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ExpectedStatuses', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" + 'title' => '', + 'description' => 'The expected status code, which is required if the health check protocol is HTTP.'."\n", + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The HTTP status code that indicates the normal health check. This parameter is required if the health check protocol is HTTP. Valid values:'."\n" ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + .'* http\\_2xx: 200'."\n" + .'* http\\_3xx: 300'."\n" + .'* http\\_4xx: 400'."\n" + .'* http\\_5xx: 500'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The health check protocol. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* TCP'."\n", 'type' => 'string', 'required' => false, 'example' => 'HTTP'], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The timeout period of responses to the health check. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The interval at which the health check is performed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'HealthyThreshold', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The healthy threshold of the health check.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'UnhealthyThreshold', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The unhealthy threshold of the health check.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'HttpPath', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The health check path, which is required if the health check protocol is HTTP.'."\n", 'type' => 'string', 'required' => false, 'example' => '/healthz'], + ], + [ + 'name' => 'HttpHost', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The health check domain name, which is optional if the health check protocol is HTTP.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether the execution was successful. Valid values:'."\n" - ."\n" - .'* true: The execution was successful.'."\n" - .'* false: The execution failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '62CBFCB8-DDC6-588C-BF1B-88828AF*****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'OK'], + 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The service ID of the operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"62CBFCB8-DDC6-588C-BF1B-88828AF*****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 12\\n}","type":"json"}]', + 'title' => 'UpdateGatewayServiceCheck', + 'summary' => 'Updates the health check policy of a specified service in a cloud-native gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceCheck', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteGatewayAuthConsumer', ], - 'GetGatewayAuthConsumerDetail' => [ - 'summary' => 'Queries the details of the consumer on which a gateway performs authentication operations.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayServiceTrafficPolicy' => [ + 'summary' => 'Updates the traffic policy of a service.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '113905', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-1a4ab101d5924b6f92c5ec98a84*****', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '429', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '120', - ], + 'schema' => ['description' => 'The ID of the service.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '411', 'title' => ''], + ], + [ + 'name' => 'GatewayTrafficPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The traffic policy of the gateway.'."\n", 'required' => true, '$ref' => '#/components/schemas/TrafficPolicy', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-75c5036c083e4f89ba8ef9fafff2e902', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* **zh-CN** (default): Chinese'."\n" + .'* **en-US**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The name of the consumer.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ConsumerStatus' => [ - 'description' => 'The status of the consumer. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PrimaryUser' => [ - 'description' => 'The creator.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'Type' => [ - 'description' => 'The authentication type. Valid values:'."\n" - ."\n" - .'* JWT'."\n", - 'type' => 'string', - 'example' => 'JWT', - ], - 'GmtCreate' => [ - 'description' => 'The time when the consumer authentication record was created.'."\n", - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'GmtModified' => [ - 'description' => 'The time when the consumer authentication record was modified.'."\n", - 'type' => 'string', - 'example' => '2023-02-01 14:17:57', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'EncodeType' => [ - 'description' => 'The encryption type. Valid values:'."\n" - ."\n" - .'* RSA'."\n" - .'* OCT'."\n", - 'type' => 'string', - 'example' => 'RSA', - ], - 'Jwks' => [ - 'description' => 'The JWT public key. The JSON format is supported.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "keys": ['."\n" - .' {'."\n" - .' "e": "AQAB",'."\n" - .' "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ",'."\n" - .' "kty": "RSA",'."\n" - .' "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - 'TokenName' => [ - 'description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenPass' => [ - 'description' => 'Specifies whether to enable pass-through.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TokenPosition' => [ - 'description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenPrefix' => [ - 'description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer `.'."\n", - 'type' => 'string', - 'example' => 'Bearer ', - ], - 'KeyName' => [ - 'description' => 'The name of the key used for JWT-based identity authentication.'."\n", - 'type' => 'string', - 'example' => 'iss', - ], - 'KeyValue' => [ - 'description' => 'The value of the key used for JWT-based identity authentication.'."\n", - 'type' => 'string', - 'example' => 'abcd', - ], - 'ResourceList' => [ - 'description' => 'The resource list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the authorized resource for the consumer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'ConsumerId' => [ - 'description' => 'The consumer ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RouteId' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3458', - ], - 'RouteName' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceStatus' => [ - 'description' => 'The resource authorization state. Valid values:'."\n" - ."\n" - .'* true: Resource authorization is enabled.'."\n" - .'* false: Resource authorization is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-4822033a8513496fa10f05c934f*****', - ], - 'GmtCreate' => [ - 'description' => 'The time when the resource associated with the consumer authentication record was created.'."\n", - 'type' => 'string', - 'example' => '2022-12-06 01:38:03', - ], - 'GmtModified' => [ - 'description' => 'The time when the resource associated with the consumer authentication record was modified.'."\n", - 'type' => 'string', - 'example' => '2022-12-06 01:38:03', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '11A61389-F896-5231-A4FB-074D9E2E0055'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The details of the data.'."\n", 'example' => '{\'GatewayUniqueId\': \'gw-2b8ebd75dc554c37a4279ba9917379f2\', \'Id\': 417, \'GatewayTrafficPolicy\': {\'LoadBalancerSettings\': {\'LoadbalancerType\': \'ROUND_ROBIN\'}, \'TlsSetting\': {\'TlsMode\': \'DISABLE\'}}}', '$ref' => '#/components/schemas/GatewayService', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11A61389-F896-5231-A4FB-074D9E2E0055\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"GatewayTrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"6456988-cn-hangzhou\\",\\n \\"CaCertContent\\": \\"-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----\\",\\n \\"Sni\\": \\"www.aliyun.com\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"test\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"test\\",\\n \\"Path\\": \\"/path\\",\\n \\"TTL\\": \\"10s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"QUERY_PARAMETER\\"\\n },\\n \\"WarmupDuration\\": 5\\n }\\n },\\n \\"GatewayUniqueId\\": \\"gw-913a49bab6c5461187a3305fb8da****\\",\\n \\"MetaInfo\\": \\"[\\\\\\\\\\\\\\"192.168.0.xxx:80\\\\\\\\\\\\\\"]\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayServiceTrafficPolicy', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceTrafficPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"ConsumerStatus\\": true,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"Type\\": \\"JWT\\",\\n \\"GmtCreate\\": \\"2023-02-01 14:17:57\\",\\n \\"GmtModified\\": \\"2023-03-01 14:17:57\\",\\n \\"Description\\": \\"描述\\",\\n \\"EncodeType\\": \\"RSA\\",\\n \\"Jwks\\": \\"{\\\\n \\\\\\"keys\\\\\\": [\\\\n {\\\\n \\\\\\"e\\\\\\": \\\\\\"AQAB\\\\\\",\\\\n \\\\\\"kid\\\\\\": \\\\\\"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\\\\\\",\\\\n \\\\\\"kty\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"n\\\\\\": \\\\\\"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"TokenName\\": \\"Authorization\\",\\n \\"TokenPass\\": true,\\n \\"TokenPosition\\": \\"HEADER\\",\\n \\"TokenPrefix\\": \\"Bearer \\",\\n \\"KeyName\\": \\"iss\\",\\n \\"KeyValue\\": \\"abcd\\",\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 16,\\n \\"ConsumerId\\": 123,\\n \\"RouteId\\": 3458,\\n \\"RouteName\\": \\"test\\",\\n \\"ResourceStatus\\": true,\\n \\"GatewayUniqueId\\": \\"gw-4822033a8513496fa10f05c934f*****\\",\\n \\"GmtCreate\\": \\"2022-12-06 01:38:03\\",\\n \\"GmtModified\\": \\"2022-12-06 01:38:03\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayAuthConsumerDetail', ], - 'AddBlackWhiteList' => [ - 'summary' => 'Creates a blacklist or a whitelist.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayServiceVersion' => [ + 'summary' => 'Updates the service version of a gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -50188,124 +34179,131 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '36594', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '90281', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-0fe488252dc44d55a9dd57875193****', - ], + 'schema' => ['description' => 'The ID of the service.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '575', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the blacklist or whitelist. Valid values:'."\n" - ."\n" - .'* GATEWAY'."\n" - .'* DOMAIN'."\n" - .'* ROUTE'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GATEWAY', - ], + 'schema' => ['description' => 'The version of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"name\\":\\"v3\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v3\\"}]}', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of object in the blacklist or whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-eccf313e2224438ba53d95d039e5****', 'title' => ''], ], [ - 'name' => 'Content', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The content of the blacklist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.117.115.51', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D6580AA6-E285-58D2-B00B-12C051B3B7BF'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The data of the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '614', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the blacklist.'."\n" - ."\n" - .'* on: enabled'."\n" - .'* off: disabled'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6580AA6-E285-58D2-B00B-12C051B3B7BF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 614\\n}","type":"json"}]', + 'title' => 'UpdateGatewayServiceVersion', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'IsWhite', - 'in' => 'query', - 'schema' => [ - 'description' => 'The whitelist. Default value: No.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'UpdateGatewaySpec' => [ + 'summary' => 'Updates the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ResourceIdJsonList', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource IDs in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[123]', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ - 'name' => 'Note', + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => 'The description.'."\n", + 'title' => '', + 'description' => 'The node specifications of the gateway.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'this is a note', + 'required' => true, + 'enumValueTitles' => ['MSE_GTW_16_32_200_c' => 'MSE_GTW_16_32_200_c', 'MSE_GTW_2_4_200_c' => 'MSE_GTW_2_4_200_c', 'MSE_GTW_4_8_200_c' => 'MSE_GTW_4_8_200_c', 'MSE_GTW_8_16_200_c' => 'MSE_GTW_8_16_200_c'], + 'example' => 'MSE_GTW_4_8_200_c', ], ], [ - 'name' => 'Name', + 'name' => 'Replica', 'in' => 'query', - 'schema' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['title' => '', 'description' => 'The number of nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -50315,1131 +34313,705 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '966F6CA7-16D0-50AB-AB02-E140934F90C1', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The ID of the record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'gw-892ehbv7gg56******', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"gw-892ehbv7gg56******\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewaySpec', + 'description' => 'You can call this operation to update the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway. If you add nodes or increase the specifications, you will incur fees. For more information, see [Pricing](~~250950~~).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewaySpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"966F6CA7-16D0-50AB-AB02-E140934F90C1\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 2\\n}","type":"json"}]', - 'title' => 'AddBlackWhiteList', ], - 'UpdateBlackWhiteList' => [ - 'summary' => 'Modifies the blacklist or whitelist of a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateImage' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '36595', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], + 'abilityTreeCode' => '43431', + 'abilityTreeNodes' => ['FEATUREmseLINUSD'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the blacklist.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the destination cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mse-8e8e9060'], ], [ - 'name' => 'ResourceType', + 'name' => 'VersionCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'GATEWAY', - ], + 'schema' => ['title' => '', 'description' => 'The destination version number.'."\n" + ."\n" + .'> You must call the GetImage operation to obtain the maximum destination version number that corresponds to MaxVersionCode.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ZooKeeper_3_5_5'], ], [ - 'name' => 'Type', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the blacklist or whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3855D475-2B66-5CFF-9A51-3D698E52C472'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success'], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the blacklist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.2.11', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3855D475-2B66-5CFF-9A51-3D698E52C472\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateImage', + 'summary' => 'Updates the version number of the destination cluster.', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the blacklist or whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateImage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - 'example' => 'on', ], ], + ], + ], + 'UpdateIsolationRule' => [ + 'summary' => 'Update an isolation rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'GatewayUniqueId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163571', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'], ], [ - 'name' => 'IsWhite', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the whitelist.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'spring-cloud-a'], ], [ - 'name' => 'ResourceIdJsonList', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource IDs in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[123]', - ], + 'schema' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], [ - 'name' => 'Note', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a note', - ], + 'schema' => ['description' => 'The concurrency threshold for the isolation rule.', 'type' => 'number', 'format' => 'float', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '3'], ], [ - 'name' => 'Name', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => 'Specifies whether to enable the rule.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hkhon1po62@c3df23522******'], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source application.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The response language. Valid values: zh (Chinese) and en (English). Default value: zh.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Data' => [ - 'description' => 'The ID of the record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', + 'title' => '', + 'description' => 'The rule details.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The microservice namespace to which the application belongs.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => 'The name of the interface to which the rule applies. This value must match the interface name on the API details page in the console.', 'type' => 'string', 'title' => '', 'example' => '/a'], + 'Threshold' => ['description' => 'The concurrency threshold.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '3'], + 'Enable' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'LimitApp' => ['description' => 'The source application.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'UpdateIsolationRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 13\\n}","type":"json"}]', - 'title' => 'UpdateBlackWhiteList', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"LimitApp\\": \\"\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GatewayBlackWhiteList' => [ - 'summary' => 'Queries a list of blacklists and whitelists of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateLocalityRule' => [ + 'summary' => 'Updates the Intra-zone Provider First rules', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], + 'schema' => ['description' => 'Region', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], + 'schema' => ['description' => 'The name of the Microservices Engine (MSE) namespace', 'type' => 'string', 'example' => 'myNamespace', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'FilterParams', + 'name' => 'AppName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'parse from filterParams', - 'description' => 'The filter parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'GatewayId' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway. If this parameter is used together with the GatewayId parameter, the value of the GatewayId parameter is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'ResourceType' => [ - 'description' => 'This parameter is unavailable for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'Type' => [ - 'description' => 'This parameter is unavailable for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => ' ""', - ], - 'IsWhite' => [ - 'description' => 'This parameter is unavailable for public use.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => ' ""', - ], - 'SearchType' => [ - 'description' => 'The query type. Valid values:'."\n" - ."\n" - .'* ROUTE: The list is queried by route. If the value of this parameter is ROUTE, set the SearchContent parameter to the route name.'."\n" - .'* DOMAIN: The list is queried by domain name. If the value of this parameter is DOMAIN, set the SearchContent parameter to the domain name.'."\n" - .'* IP: The list is queried by specified IP address. If the value of this parameter is IP, set the SearchContent parameter to the IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - 'SearchContent' => [ - 'description' => 'The content that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'Application name', 'type' => 'string', 'example' => 'example-app', 'maxLength' => 64, 'title' => '', 'required' => false], ], [ - 'name' => 'OrderItem', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'schema' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******', 'title' => ''], ], [ - 'name' => 'DescSort', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable for public use.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '""', - 'default' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to enable the Intra-zone Provider First feature.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved and not in use.', 'type' => 'string', 'required' => false, 'example' => 'No input required', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'Rule Source', 'type' => 'string', 'required' => false, 'example' => 'edasmsc', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Intra-zone Provider First feature to take effect. If the percentage of instances of the application that are deployed in a zone exceeds the specified threshold, the Intra-zone Provider First feature is enabled for the zone. This indicates that when a consumer initiates a request to the application, the request is preferentially routed to an instance in the same zone as the consumer.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which the returned results are displayed. Valid values: zh (default): Chinese. en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'The response parameters.>'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The placeholder in the dynamic error message. This parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic message. This parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => 'The total number of instances returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Result' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the blacklist and whitelist.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'ResourceType' => [ - 'description' => 'The effective scope of the blacklist or whitelist. Valid values:'."\n" - ."\n" - .'* GATEWAY'."\n" - .'* DOMAIN'."\n" - .'* ROUTE'."\n", - 'type' => 'string', - 'example' => 'GATEWAY', - ], - 'Content' => [ - 'description' => 'The content of the blacklist.'."\n", - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'IsWhite' => [ - 'description' => 'Specifies whether to enable the whitelist feature.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Type' => [ - 'description' => 'The type of the blacklist and whitelist. The value is fixed to IP address blacklist and whitelist.'."\n", - 'type' => 'string', - 'example' => 'IP', - ], - 'Status' => [ - 'description' => 'The status of the blacklist or whitelist.'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'GatewayId' => [ - 'description' => 'The gateway ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'GmtCreate' => [ - 'description' => 'The time when the blacklist or whitelist was created.'."\n", - 'type' => 'string', - 'example' => '2024-08-02T02:43:40.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The time when the rule was modified.'."\n", - 'type' => 'string', - 'example' => '2024-08-02T02:43:40.000+0000', - ], - 'ResourceIdJsonList' => [ - 'description' => 'The list of resource IDs in the JSON format.'."\n" - ."\n" - .'* If the value of the ResourceType parameter is ROUTE, the value of this parameter is the list of route IDs.'."\n" - .'* If the value of the ResourceType parameter is DOMAIN, the value of this parameter is the list of domain names.'."\n", - 'type' => 'string', - 'example' => '[234]', - ], - 'Note' => [ - 'description' => 'The comment.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ResourceIdNameJson' => [ - 'description' => 'The description of the resource name.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'Name' => [ - 'description' => 'The name of the blacklist.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'Message' => ['description' => 'The message that is returned for the request.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '78F05E89-D387-50CE-8186-2E27A8AB****', 'title' => ''], + 'Data' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '{'."\n" + .' "Message":"updateLocalityPolicy success",'."\n" + .' "RequestId":"3B519913-7348-16AB-AD71-******",'."\n" + .' "HttpStatusCode":200,'."\n" + .' "Code":200,'."\n" + .' "Success":true'."\n" + .'}', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"78F05E89-D387-50CE-8186-2E27A8AB****\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"Message\\\\\\":\\\\\\"updateLocalityPolicy success\\\\\\",\\\\n \\\\\\"RequestId\\\\\\":\\\\\\"3B519913-7348-16AB-AD71-******\\\\\\",\\\\n \\\\\\"HttpStatusCode\\\\\\":200,\\\\n \\\\\\"Code\\\\\\":200,\\\\n \\\\\\"Success\\\\\\":true\\\\n}\\",\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'UpdateLocalityRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateLocalityRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 1,\\n \\"Result\\": [\\n {\\n \\"Id\\": 549,\\n \\"ResourceId\\": 549,\\n \\"ResourceType\\": \\"GATEWAY\\",\\n \\"Content\\": \\"1.1.1.1\\",\\n \\"IsWhite\\": true,\\n \\"Type\\": \\"IP\\",\\n \\"Status\\": \\"on\\",\\n \\"GatewayId\\": 81,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GmtCreate\\": \\"2024-08-02T02:43:40.000+0000\\",\\n \\"GmtModified\\": \\"2024-08-02T02:43:40.000+0000\\",\\n \\"ResourceIdJsonList\\": \\"[234]\\",\\n \\"Note\\": \\"禁止的IP列表\\",\\n \\"ResourceIdNameJson\\": \\"{}\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GatewayBlackWhiteList', ], - 'DeleteBlackWhiteList' => [ - 'summary' => '删除黑白名单', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateMessageQueueRoute' => [ + 'summary' => 'Updates the canary release configurations for messaging.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '36597', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Untagged environment of the application. Ignored tags.', + 'type' => 'array', + 'items' => ['description' => 'Untagged environment of the application. Ignored tags.', 'type' => 'string', 'required' => false, 'example' => 'gray', 'title' => ''], 'required' => false, - 'example' => '430', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the canary release for messaging feature is enabled for the application. Valid values:'."\n" + ."\n" + .'- `true`: enabled.'."\n" + ."\n" + .'- `false`: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'hkhon1po62@c3df23522baa898', 'title' => ''], + ], + [ + 'name' => 'FilterSide', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.', 'type' => 'string', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => ['Server', 'Client'], 'required' => false, - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', + 'title' => '', ], ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Microservices Engine (MSE) namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 64, 'title' => '', 'required' => false], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name', 'type' => 'string', 'example' => 'example-app', 'maxLength' => 64, 'title' => '', 'required' => false], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'GATEWAY', - ], - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IP', - ], - 'IsWhite' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => '1', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '430', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-10 20:22:34', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-10 20:22:34', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E3919C62-876A-5926-A0BC-18351A24FA35', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The node data.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The status code. 200 indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E3919C62-876A-5926-A0BC-18351A24FA35\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"True\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateMessageQueueRoute', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateMessageQueueRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 120,\\n \\"ResourceId\\": 1,\\n \\"ResourceType\\": \\"GATEWAY\\",\\n \\"Content\\": \\"1.1.1.1\\",\\n \\"Type\\": \\"IP\\",\\n \\"IsWhite\\": true,\\n \\"Status\\": true,\\n \\"GatewayId\\": 430,\\n \\"GatewayUniqueId\\": \\"gw-9cdcf8e4f58144059e73ff4c5ef9****\\",\\n \\"GmtCreate\\": \\"2022-08-10 20:22:34\\",\\n \\"GmtModified\\": \\"2022-08-10 20:22:34\\"\\n }\\n}","type":"json"}]', ], - 'GetBlackWhiteList' => [ - 'summary' => 'Queries the blacklist or whitelist of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateMigrationTask' => [ + 'summary' => 'Updates a migration task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '36934', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '155125', + 'abilityTreeNodes' => ['FEATUREmseKDDXNL'], ], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GATEWAY', - ], + 'schema' => ['description' => 'The extended request parameter in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-32d5c9769c1842b1a2cc3426c59e****', - ], + 'schema' => ['description' => 'The type of a cluster.'."\n" + ."\n" + .'- Nacos-Ans'."\n" + ."\n" + .'- ZooKeeper'."\n" + ."\n" + .'- Eureka', 'type' => 'string', 'required' => false, 'example' => 'Nacos-Ans', 'title' => ''], ], [ - 'name' => 'IsWhite', + 'name' => 'OriginInstanceAddress', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the whitelist.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The source instance node address.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1:8848', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'OriginInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'Source cluster', 'title' => ''], + ], + [ + 'name' => 'OriginInstanceNamespace', + 'in' => 'query', + 'schema' => ['description' => 'The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.', 'type' => 'string', 'required' => false, 'example' => 'namesapceId1,namesapceId2', 'title' => ''], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination instance.', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-ud82*****', 'title' => ''], + ], + [ + 'name' => 'TargetClusterName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the destination instance.', 'type' => 'string', 'required' => false, 'example' => 'Target cluster', 'title' => ''], + ], + [ + 'name' => 'TargetClusterUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the destination instance.', 'type' => 'string', 'required' => false, 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', 'title' => ''], + ], + [ + 'name' => 'ProjectDesc', + 'in' => 'query', + 'schema' => ['description' => 'The description of the task.', 'type' => 'string', 'required' => false, 'example' => 'This is a description.', 'title' => ''], + ], + [ + 'name' => 'SyncType', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", + 'description' => 'The synchronization type', + 'enumValueTitles' => ['All' => 'All', 'Config' => 'Config', 'Service' => 'Service'], 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'example' => 'All', + 'title' => '', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '89CBC928-4F57-51FA-A413-EE0F4CD87200', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. ', - ], - 'Code' => [ - 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The data of the node.'."\n", + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '275', - ], - 'ResourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResourceType' => [ - 'description' => 'The type of a resource.'."\n", - 'type' => 'string', - 'example' => 'GATEWAY', - ], - 'Content' => [ - 'description' => 'The content of the blacklist.'."\n", - 'type' => 'string', - 'example' => 'text', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'IP', - ], - 'IsWhite' => [ - 'description' => 'Indicates whether the whitelist is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => 'The status of the blacklist or whitelist.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '183876217*****', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the cluster.'."\n" + ."\n" + .'- Nacos-Ans'."\n" + ."\n" + .'- ZooKeeper'."\n" + ."\n" + .'- Eureka', 'type' => 'string', 'example' => 'Nacos-Ans', 'title' => ''], + 'OriginInstanceAddress' => ['description' => 'The source instance node address.', 'type' => 'string', 'example' => '192.168.100.2:2181', 'title' => ''], + 'OriginInstanceName' => ['description' => 'The name of the source instance.', 'type' => 'string', 'example' => 'src', 'title' => ''], + 'OriginInstanceNamespace' => ['description' => 'The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.', 'type' => 'string', 'example' => 'fsdfsdfdsf', 'title' => ''], + 'TargetInstanceId' => ['description' => 'The ID of the destination instance.', 'type' => 'string', 'example' => 'mse-cn-zvp2u*****', 'title' => ''], + 'TargetClusterName' => ['description' => 'The name of the destination instance.', 'type' => 'string', 'example' => 'multiple-nacos', 'title' => ''], + 'TargetClusterUrl' => ['description' => 'The URL of the destination instance.', 'type' => 'string', 'example' => 'mse-0b*****-nacos-ans.mse.aliyuncs.com:8848', 'title' => ''], + 'ProjectDesc' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => '1232345', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the migration task was created.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the migration task was updated.', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000', 'title' => ''], + 'SyncType' => ['description' => 'The synchronization type', 'type' => 'string', 'example' => 'All', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'mse::2019-05-31::GatewayBlackWhiteList', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"UserId\\": \\"183876217*****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.100.2:2181\\",\\n \\"OriginInstanceName\\": \\"src\\",\\n \\"OriginInstanceNamespace\\": \\"fsdfsdfdsf\\",\\n \\"TargetInstanceId\\": \\"mse-cn-zvp2u*****\\",\\n \\"TargetClusterName\\": \\"multiple-nacos\\",\\n \\"TargetClusterUrl\\": \\"mse-0b*****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"1232345\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"SyncType\\": \\"All\\"\\n },\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateMigrationTask', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89CBC928-4F57-51FA-A413-EE0F4CD87200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. \\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 275,\\n \\"ResourceId\\": 1,\\n \\"ResourceType\\": \\"GATEWAY\\",\\n \\"Content\\": \\"text\\",\\n \\"Type\\": \\"IP\\",\\n \\"IsWhite\\": true,\\n \\"Status\\": \\"on\\",\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetBlackWhiteList', + 'translator' => 'manual', ], - 'AddGatewayAuth' => [ - 'summary' => 'Adds an authentication configuration for a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateNacosCluster' => [ + 'summary' => 'Updates the information about a Nacos cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -51448,1007 +35020,553 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '37105', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '105189', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jwt', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], ], [ - 'name' => 'Type', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The authentication type. JSON Web Token (JWT) authentication, OpenID Connect (OIDC) authentication, Identity as a Service (IDaaS) authentication, or custom authentication are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], + 'schema' => ['title' => '', 'description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], ], [ - 'name' => 'Issuer', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The iss value of JWT claims, which indicates the issuer. You must make sure that the value of this parameter is the same as the iss value in the payload of JWT claims.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testing@secure.istio.io', - ], + 'schema' => ['title' => '', 'description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'Jwks', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The JWT public key. The JSON format is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], ], [ - 'name' => 'TokenPosition', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => 'The position of the parameter that is required to verify a token. By default, a token is prefixed with Bearer and stored in the authorization header. Example: `Authorization: Bearer token`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], + 'schema' => ['title' => '', 'description' => 'The name of the Nacos cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DEFAULT'], ], [ - 'name' => 'TokenName', + 'name' => 'CheckPort', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the parameter that is required to verify a token. By default, a token is prefixed with Bearer and stored in the authorization header. Example: `Authorization: Bearer token`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], + 'schema' => ['title' => '', 'description' => 'The port used for health checks.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], ], [ - 'name' => 'TokenNamePrefix', + 'name' => 'UseInstancePortForCheck', 'in' => 'query', - 'schema' => [ - 'description' => 'The name prefix of the parameter that is required to verify a token. By default, a token is prefixed with Bearer and stored in the authorization header. Example: `Authorization: Bearer token`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer ', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to use the port of the instance for a health check.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'TokenPass', + 'name' => 'HealthChecker', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable pass-through.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The type of the health check.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"type":"none"}'], ], [ - 'name' => 'IsWhite', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the whitelist feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Status', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The status.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '', 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '', 'description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '', 'description' => 'The result returned.'."\n", 'type' => 'string', 'example' => 'ok'], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'RedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'The redirect URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://test-.com/oauth2/callback', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'UpdateNacosCluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], ], ], + ], + ], + 'UpdateNacosConfig' => [ + 'summary' => 'Updates a Nacos configuration.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17102', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'ClientId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID registered with the OIDC authentication service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23460e2fdd9bf9ad106****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-7pp2a****', 'title' => ''], ], [ - 'name' => 'ClientSecret', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application secret registered with the OIDC authentication service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], + 'schema' => ['description' => 'The ID of the configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ky-check-****.yml', 'title' => ''], ], [ - 'name' => 'CookieDomain', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name of the cookie. After the authentication is passed, the cookie is sent to the specified domain name to maintain the logon status. For example, if you set `Cookie-domain` to a.example.com, the cookie is sent to the domain name `a.example.com`. If you set `Cookie-domain` to .example.com, the cookie is sent to all subdomains of `example.com`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], + 'schema' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'resource', 'title' => ''], ], [ - 'name' => 'ScopesList', + 'name' => 'AppName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The OIDC scope.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The OIDC scope.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Separate multiple values with semicolons (;).'."\n", - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'postoffice', 'title' => ''], ], [ - 'name' => 'LoginUrl', + 'name' => 'Tags', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL that is used to log on to the IDaaS instance.', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], + 'schema' => ['description' => 'The list of tags.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2021-10-20', 'title' => ''], ], [ - 'name' => 'Sub', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => 'The sub value of JWT claims, which indicates the subject. You must make sure that the value of this parameter is the same as the sub value in the payload of JWT claims. If you do not set this parameter or leave it empty, the default value, which is the value of the Issuer parameter, is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testing@secure.istio.io', - ], + 'schema' => ['description' => 'The description of the configuration.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Base configuration', 'title' => ''], ], [ - 'name' => 'ExternalAuthZJSON', + 'name' => 'Type', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the custom authentication service.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'PrefixPath' => [ - 'description' => 'The path of the authentication API provided by the authentication service. The path supports the prefix match method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/auth', - ], - 'TokenKey' => [ - 'description' => 'The header that stores a token in an authentication request. In most cases, a token is stored in the Authorization or Cookie header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], - 'AllowRequestHeaders' => [ - 'description' => 'The header that can be carried in an authentication request.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The OIDC scope.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x-req', - ], - 'required' => false, - ], - 'AllowUpstreamHeaders' => [ - 'description' => 'The header that can be retained in an authentication response.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'x-resp', - ], - 'required' => false, - ], - 'Timeout' => [ - 'description' => 'The timeout period. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'IsRestrict' => [ - 'description' => 'Specifies whether the gateway allows a client request when the authentication server is unavailable. If a connection to the authentication server fails to be established or a 5xx error code is returned, the authentication server is unavailable.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'WithRequestBody' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4000000', - ], - 'WithRematchRoute' => [ - 'type' => 'boolean', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The format of the configuration. Supported formats include TEXT, JSON, XML, and HTML.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'text', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The content of the configuration.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7', - ], + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '78b7af66-d15f-4541-b886-11ed81ecb6c0', 'title' => ''], ], [ - 'name' => 'AuthResourceMode', + 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'title' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'schema' => ['description' => 'The MD5 value of the configuration.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '045439703a273a94306422b****', 'title' => ''], ], [ - 'name' => 'AuthResourceConfig', + 'name' => 'BetaIps', 'in' => 'query', - 'schema' => [ - 'title' => '复杂模式的YAML配置', - 'type' => 'string', - ], + 'schema' => ['description' => 'The list of IP addresses where the beta release of the configuration is performed.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '196.168.XX.XX', 'title' => ''], ], [ - 'name' => 'AuthResourceList', + 'name' => 'EncryptedDataKey', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the resource to be authorized.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'DomainId' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Path' => [ - 'description' => 'The request path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'MatchType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'IgnoreCase' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AuthResourceHeaderList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'x-req', - ], - 'HeaderMethod' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The encryption key.'."\n", 'type' => 'string', 'required' => false, 'example' => '122wdwe****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4279C00F-A5E1-53C6-A43B-751C1C524D0B', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], + 'HttpCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4279C00F-A5E1-53C6-A43B-751C1C524D0B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 333\\n}","type":"json"}]', - 'title' => 'AddGatewayAuth', - ], - 'UpdateGatewayAuth' => [ - 'summary' => '更新网关认证', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateNacosConfig', + 'description' => '> The current API operation is not provided in Nacos SDK. For more information about Nacos SDK, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateNacosGrayConfig' => [ + 'summary' => 'Updates the canary release settings, including beta release and tag-based canary release.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '37106', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215876', + 'abilityTreeNodes' => ['FEATUREmseK09GZC'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mse_prepaid_public_cn-st2212****'], ], [ - 'name' => 'Type', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ExternalAuthZ', - ], + 'schema' => ['description' => 'The namespace ID. Default value: public.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba'], ], [ - 'name' => 'Issuer', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The group name. Default value: DEFAULT\\_GROUP.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'Jwks', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', - ], + 'schema' => ['description' => 'The data ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], ], [ - 'name' => 'TokenPosition', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], + 'schema' => ['description' => 'The configuration content.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'asdf'], ], [ - 'name' => 'TokenName', + 'name' => 'GrayType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The canary release type. Beta release (IP address-based canary release) and tag-based canary release are supported.', 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', + 'required' => true, + 'enum' => ['Beta', 'Tags'], + 'title' => '', + 'example' => 'Tags', ], ], [ - 'name' => 'TokenNamePrefix', + 'name' => 'GrayRule', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer', - ], + 'schema' => ['description' => 'The canary release rule. For a beta release, you can specify one or more client IP addresses for this parameter. You must separate multiple IP addresses with commas (,). For a tag-based canary release, the value is in the format of Tag name=Tag value. You must separate multiple tag values with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'key=value1,value2', 'title' => ''], ], [ - 'name' => 'TokenPass', + 'name' => 'StopGray', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to stop the canary release.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'Status', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '719', - ], + 'schema' => ['description' => 'The extended request parameter in the JSON format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'RedirectUrl', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://test-.com/oauth2/callback', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'ClientId', + 'name' => 'GrayRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'app_mnvxaavggw7hcdcnr6usi6***', - ], + 'schema' => ['description' => 'The canary version name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'test'], ], [ - 'name' => 'ClientSecret', + 'name' => 'GrayRulePriority', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****', - ], + 'schema' => ['description' => 'The canary version priority.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '100'], ], [ - 'name' => 'CookieDomain', + 'name' => 'OpType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], + 'schema' => ['description' => 'The operation type. Valid values: Create (create a canary release configuration) and Update (update an existing canary release configuration).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Create'], ], [ - 'name' => 'ScopesList', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'openid', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], - 'required' => false, + 'example' => '', ], ], - [ - 'name' => 'LoginUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - 'name' => 'Sub', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateNacosGrayConfig', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ExternalAuthZJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '37396', - ], - 'PrefixPath' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/auth', - ], - 'TokenKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], - 'AllowRequestHeaders' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'x-req', - ], - 'required' => false, - ], - 'AllowUpstreamHeaders' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'x-resp', - ], - 'required' => false, - ], - 'Timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'IsRestrict' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'WithRequestBody' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4000000', - ], - 'WithRematchRoute' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'UpdateNacosInstance' => [ + 'summary' => 'Updates the information about application instances that are registered with a Nacos instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '18554', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], + ], + 'parameters' => [ [ - 'name' => 'IsWhite', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], ], [ - 'name' => 'AuthResourceMode', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], ], [ - 'name' => 'AuthResourceConfig', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '复杂模式的YAML配置', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], + 'schema' => ['title' => '', 'description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'AuthResourceList', + 'name' => 'NamespaceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'DomainId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1765', - ], - 'Path' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'MatchType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'IgnoreCase' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'AuthResourceHeaderList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'x-req', - ], - 'HeaderMethod' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0****'], ], [ - 'name' => 'DeleteResourceIdList', + 'name' => 'ClusterName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'The name of the Nacos instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The IP address of the Nacos instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '1.2.X.X'], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The port number of the Nacos instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12281'], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether the node is a non-persistent node. Valid values:'."\n" + ."\n" + .'* `true`: yes.'."\n" + .'* `false`: no.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false'], + ], + [ + 'name' => 'Weight', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The weight. Valid values: 0 to 10000. The value must be an integer. A larger value indicates a higher frequency at which the instance is accessed.'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to disable this service. Valid values:'."\n" + ."\n" + .'* `true`: yes.'."\n" + .'* `false`: no.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + [ + 'name' => 'Metadata', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The metadata of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '[int]'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The string object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '719', - ], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '', 'description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '', 'description' => 'The result of the modification.'."\n", 'type' => 'string', 'example' => 'ok'], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateNacosInstance', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 719\\n}","type":"json"}]', ], - 'GetGatewayAuthDetail' => [ - 'summary' => 'Obtains the authentication details of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateNacosService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -52457,570 +35575,112 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '37108', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '105086', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '鉴权ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1100', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'GatewayId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID（和网关唯一ID二选一）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2274', - ], + 'schema' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'com.dingtalk.doc.thumbnails.pdf.ThumbnailService'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID（和网关ID二选一，网关唯一ID不为空时优先使用网关唯一ID查询）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', - ], + 'schema' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26'], + ], + [ + 'name' => 'ProtectThreshold', + 'in' => 'query', + 'schema' => ['description' => 'The protection threshold.'."\n", 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP 状态码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'title' => '用于和Success同步，当Success为true时，Code为200', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '鉴权详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '鉴权ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1100', - ], - 'Name' => [ - 'title' => '鉴权名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'title' => '鉴权所属网关的唯一ID', - 'description' => '', - 'type' => 'string', - 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', - ], - 'GatewayId' => [ - 'title' => '鉴权所属网关的ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2274', - ], - 'Type' => [ - 'title' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'description' => '', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Issuer' => [ - 'title' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'Jwks' => [ - 'title' => 'JWT公钥，JSON格式', - 'description' => '', - 'type' => 'string', - 'example' => '{\\n \\"keys\\":[\\n {\\n \\"kty\\": \\"RSA\\",\\n \\"e\\": \\"AQAB\\",\\n \\"use\\": \\"sig\\",\\n \\"kid\\": \\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\",\\n \\"alg\\": \\"RS256\\",\\n \\"n\\": \\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\"\\n }\\n ]\\n}\\n', - ], - 'IsWhite' => [ - 'title' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreate' => [ - 'title' => '鉴权创建的GMT时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-02-19T02:41:03.000+0000', - ], - 'GmtModified' => [ - 'title' => '鉴权修改的GMT时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-02-19T02:41:03.000+0000', - ], - 'TokenPosition' => [ - 'title' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输', - 'description' => '', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenName' => [ - 'title' => 'JWT Token保存的位置', - 'description' => '', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenNamePrefix' => [ - 'title' => 'JWT Token的前缀', - 'description' => '', - 'type' => 'string', - 'example' => 'Bearer ', - ], - 'TokenPass' => [ - 'title' => '是否透传Token', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'title' => '鉴权是否开启', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RedirectUrl' => [ - 'title' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'description' => '', - 'type' => 'string', - 'example' => 'https://yourdomain/path', - ], - 'ClientId' => [ - 'title' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'description' => '', - 'type' => 'string', - 'example' => 'example-app', - ], - 'ClientSecret' => [ - 'title' => '服务注册的应用Secret（OIDC/IDaaS使用）。', - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'CookieDomain' => [ - 'title' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', - 'description' => '', - 'type' => 'string', - 'example' => 'hello.com', - ], - 'ScopesList' => [ - 'title' => 'OIDC 作用域（OIDC 使用）。', - 'description' => '', - 'type' => 'string', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'openid', - 'extendType' => 'true', - ], - 'example' => '["openid","email"]', - ], - 'LoginUrl' => [ - 'title' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'description' => '', - 'type' => 'string', - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], - 'Sub' => [ - 'title' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'ExternalAuthZ' => [ - 'title' => '自定义鉴权信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'title' => '鉴权服务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15300', - ], - 'PrefixPath' => [ - 'title' => '鉴权API的Path', - 'description' => '', - 'type' => 'string', - 'example' => '/auth', - ], - 'TokenKey' => [ - 'title' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', - 'description' => '', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'AllowRequestHeaders' => [ - 'title' => '允许的请求头部', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x-req', - ], - ], - 'AllowUpstreamHeaders' => [ - 'title' => '允许的响应头部', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x-resp', - ], - ], - 'Timeout' => [ - 'title' => '鉴权服务的超时时间，单位：秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'IsRestrict' => [ - 'title' => '自定义鉴权模式：'."\n" - ."\n" - .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" - .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Service' => [ - 'title' => '鉴权服务信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '鉴权服务名称', - 'description' => '', - 'type' => 'string', - 'example' => ' httpbin-auth-service', - ], - 'SourceType' => [ - 'title' => '鉴权服务来源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'K8S', - ], - 'GroupName' => [ - 'title' => '鉴权服务所属的分组', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Namespace' => [ - 'title' => '鉴权服务命名空间', - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - 'WithRequestBody' => [ - 'title' => '是否允许携带Body', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'title' => 'Body的最大字节数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4000000', - ], - 'WithRematchRoute' => [ - 'type' => 'boolean', - ], - ], - ], - 'ResourceList' => [ - 'title' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '授权规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1303', - ], - 'AuthId' => [ - 'title' => '规则所归属鉴权的ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2274', - ], - 'DomainId' => [ - 'title' => '规则内域名的ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1765', - ], - 'DomainName' => [ - 'title' => '规则内的域名', - 'description' => '', - 'type' => 'string', - 'example' => 'example.com', - ], - 'Path' => [ - 'title' => '规则的匹配路径', - 'description' => '', - 'type' => 'string', - 'example' => '/test', - ], - 'IsWhite' => [ - 'title' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewayId' => [ - 'title' => '规则所属网关的ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2274', - ], - 'GatewayUniqueId' => [ - 'title' => '规则所属网关的唯一ID', - 'description' => '', - 'type' => 'string', - 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', - ], - 'GmtCreate' => [ - 'title' => '授权规则的创建GMT时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-02-19T03:32:38.000+0000', - ], - 'GmtModified' => [ - 'title' => '授权规则的修改GMT时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-02-19T03:32:38.000+0000', - ], - 'MatchType' => [ - 'title' => '请求Path的匹配类型：'."\n" - ."\n" - .'- EQUAL：精确匹配'."\n" - .'- PRE：前缀匹配'."\n" - .'- ERGULAR：正则匹配', - 'description' => '', - 'type' => 'string', - 'example' => 'EQUAL', - ], - 'IgnoreCase' => [ - 'title' => '路径是否开启大小写敏感'."\n" - ."\n" - .'- true：开启大小写敏感'."\n" - .'- false：关闭大小写敏感', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AuthResourceHeaderList' => [ - 'title' => '规则的请求头（当前仅供自定义鉴权使用）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'title' => '请求头名称', - 'description' => '', - 'type' => 'string', - 'example' => 'x-req', - ], - 'HeaderMethod' => [ - 'title' => '匹配条件：'."\n" - ."\n" - .'- EQUAL：等于'."\n" - .'- NOT_EQUAL：不等于'."\n" - .'- EXIST：存在'."\n" - .'- NOT_EXIST：不存在'."\n" - .'- INCLUDE：包含'."\n" - .'- EXCLUDE：不包含'."\n" - .'- PREFIX：前缀'."\n" - .'- SUFFIX：后缀'."\n" - .'- REGREX：正则', - 'description' => '', - 'type' => 'string', - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'title' => '请求头的值', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - ], - ], - ], - 'AuthResourceMode' => [ - 'title' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'AuthResourceConfig' => [ - 'title' => '复杂模式的YAML配置', - 'type' => 'string', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The details of the data.'."\n", 'type' => 'string', 'example' => '6'], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"6\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'UpdateNacosService', + 'summary' => 'Updates the information about a Nacos service.', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1100,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-6f0dbd108a0249d2b675b3ef50b*****\\",\\n \\"GatewayId\\": 2274,\\n \\"Type\\": \\"JWT\\",\\n \\"Issuer\\": \\"https://example.com/auth\\",\\n \\"Jwks\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"keys\\\\\\\\\\\\\\":[\\\\\\\\n {\\\\\\\\n \\\\\\\\\\\\\\"kty\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"RSA\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"e\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"AQAB\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"use\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"sig\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"kid\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"alg\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"RS256\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"n\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n ]\\\\\\\\n}\\\\\\\\n\\",\\n \\"IsWhite\\": true,\\n \\"GmtCreate\\": \\"2024-02-19T02:41:03.000+0000\\",\\n \\"GmtModified\\": \\"2024-02-19T02:41:03.000+0000\\",\\n \\"TokenPosition\\": \\"HEADER\\",\\n \\"TokenName\\": \\"Authorization\\",\\n \\"TokenNamePrefix\\": \\"Bearer \\",\\n \\"TokenPass\\": true,\\n \\"Status\\": false,\\n \\"RedirectUrl\\": \\"https://yourdomain/path\\",\\n \\"ClientId\\": \\"example-app\\",\\n \\"ClientSecret\\": \\"xxxxx\\",\\n \\"CookieDomain\\": \\"hello.com\\",\\n \\"ScopesList\\": \\"[\\\\\\"openid\\\\\\",\\\\\\"email\\\\\\"]\\",\\n \\"LoginUrl\\": \\"https://daxxxxcn.aliyunidaas.com/\\",\\n \\"Sub\\": \\"https://example.com/auth\\",\\n \\"ExternalAuthZ\\": {\\n \\"ServiceId\\": 15300,\\n \\"PrefixPath\\": \\"/auth\\",\\n \\"TokenKey\\": \\"Authorization\\",\\n \\"AllowRequestHeaders\\": [\\n \\"x-req\\"\\n ],\\n \\"AllowUpstreamHeaders\\": [\\n \\"x-resp\\"\\n ],\\n \\"Timeout\\": 10,\\n \\"IsRestrict\\": true,\\n \\"Service\\": {\\n \\"Name\\": \\" httpbin-auth-service\\",\\n \\"SourceType\\": \\"K8s\\",\\n \\"GroupName\\": \\"test\\",\\n \\"Namespace\\": \\"default\\"\\n },\\n \\"WithRequestBody\\": true,\\n \\"BodyMaxBytes\\": 4000000,\\n \\"WithRematchRoute\\": true\\n },\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 1303,\\n \\"AuthId\\": 2274,\\n \\"DomainId\\": 1765,\\n \\"DomainName\\": \\"example.com\\",\\n \\"Path\\": \\"/test\\",\\n \\"IsWhite\\": true,\\n \\"GatewayId\\": 2274,\\n \\"GatewayUniqueId\\": \\"gw-6f0dbd108a0249d2b675b3ef50b*****\\",\\n \\"GmtCreate\\": \\"2024-02-19T03:32:38.000+0000\\",\\n \\"GmtModified\\": \\"2024-02-19T03:32:38.000+0000\\",\\n \\"MatchType\\": \\"EQUAL\\",\\n \\"IgnoreCase\\": true,\\n \\"AuthResourceHeaderList\\": [\\n {\\n \\"HeaderKey\\": \\"x-req\\",\\n \\"HeaderMethod\\": \\"EQUAL\\",\\n \\"HeaderValue\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"AuthResourceMode\\": 0,\\n \\"AuthResourceConfig\\": \\"permissions:\\\\n - not_rule:\\\\n or_rules:\\\\n rules:\\\\n - and_rules:\\\\n rules:\\\\n - url_path:\\\\n path:\\\\n ignore_case: false\\\\n prefix: /version\\\\n - and_rules:\\\\n rules:\\\\n - url_path:\\\\n path:\\\\n ignore_case: false\\\\n prefix: /header\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayAuthDetail', ], - 'ListGatewayAuth' => [ - 'summary' => '查询网关认证', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdatePluginConfig' => [ + 'summary' => 'Updates plug-in configurations.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -53029,443 +35689,139 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '37107', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '128635', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'description' => '', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OrderItem', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', 'title' => ''], ], [ - 'name' => 'DescSort', + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['description' => 'The plug-in configuration. Configurations of WebAssembly plug-ins are in the YAML format, and configurations of Lua plug-ins are in the Lua code.'."\n", 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ConfigLevel', + 'in' => 'query', + 'schema' => ['description' => '-'."\n" + ."\n" + .'-'."\n" + ."\n" + .'-', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResourceIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'example' => '200', 'description' => '', 'title' => '', 'required' => false], 'description' => '', - 'type' => 'boolean', + 'title' => '', 'required' => false, - 'example' => 'false', + 'example' => '', ], ], [ - 'name' => 'FilterParams', + 'name' => 'GmtCreate', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rutain-test', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], - 'Status' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'IsWhite' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-5017305290e14centbrveca****', - ], - ], - 'required' => false, - ], + 'schema' => ['type' => 'string', 'deprecated' => true, 'description' => '', 'required' => false, 'example' => '1667309705000', 'title' => ''], + ], + [ + 'name' => 'GmtModified', + 'in' => 'query', + 'schema' => ['type' => 'string', 'deprecated' => true, 'description' => '', 'required' => false, 'example' => '1667309705000', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['type' => 'string', 'example' => 'zh', 'description' => '', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EC1EED4A-B147-597B-B949-FD3131AB4298', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Issuer' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'Jwks' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"keys\\":[{\\"kty\\":\\"oct\\",\\"k\\":\\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\\",\\"alg\\":\\"HS256\\"}]}', - ], - 'TokenPosition' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenNamePrefix' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Bearer', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'TokenPass' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsWhite' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://test.com/oauth2/callback', - ], - 'ClientId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'app_mnvxaavggw7hcdcnr6usi6***', - ], - 'ClientSecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****', - ], - 'CookieDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test.com', - ], - 'ScopesList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["openid"]', - ], - 'LoginUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' '."\n" - .'https://daxxxxcn.aliyunidaas.com/', - ], - 'Sub' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example-app', - ], - 'ExternalAuthZ' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45186', - ], - 'PrefixPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/auth', - ], - 'TokenKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'AllowRequestHeaders' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x-req', - ], - ], - 'AllowUpstreamHeaders' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x-resp', - ], - ], - 'Timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'WithRequestBody' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'WithRematchRoute' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'IsRestrict' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Service' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'updatetime', - ], - 'SourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MSE', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.mse.console.test.3YXO', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], - ], - 'AuthResourceMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => '200'], + 'ErrorCode' => ['type' => 'string', 'description' => '', 'example' => '500', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'success', 'title' => ''], + 'DynamicMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'code'], + 'Data' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"code\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'UpdatePluginConfig', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdatePluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC1EED4A-B147-597B-B949-FD3131AB4298\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 549,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"GatewayId\\": 1,\\n \\"Type\\": \\"JWT\\",\\n \\"Issuer\\": \\"https://example.com/auth\\",\\n \\"Jwks\\": \\"{\\\\\\\\\\\\\\"keys\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"kty\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oct\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"k\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alg\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HS256\\\\\\\\\\\\\\"}]}\\",\\n \\"TokenPosition\\": \\"HEADER\\",\\n \\"TokenName\\": \\"Authorization\\",\\n \\"TokenNamePrefix\\": \\"Bearer\\",\\n \\"GmtCreate\\": \\"2021-09-13 19:24:23\\",\\n \\"GmtModified\\": \\"2021-09-13 19:24:23\\",\\n \\"TokenPass\\": true,\\n \\"IsWhite\\": true,\\n \\"Status\\": true,\\n \\"RedirectUrl\\": \\"http://test.com/oauth2/callback\\",\\n \\"ClientId\\": \\"app_mnvxaavggw7hcdcnr6usi6***\\",\\n \\"ClientSecret\\": \\"CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****\\",\\n \\"CookieDomain\\": \\"test.com\\",\\n \\"ScopesList\\": \\"[\\\\\\"openid\\\\\\"]\\",\\n \\"LoginUrl\\": \\"\\\\t\\\\nhttps://daxxxxcn.aliyunidaas.com/\\",\\n \\"Sub\\": \\"example-app\\",\\n \\"ExternalAuthZ\\": {\\n \\"ServiceId\\": 45186,\\n \\"PrefixPath\\": \\"/auth\\",\\n \\"TokenKey\\": \\"Authorization\\",\\n \\"AllowRequestHeaders\\": [\\n \\"x-req\\"\\n ],\\n \\"AllowUpstreamHeaders\\": [\\n \\"x-resp\\"\\n ],\\n \\"Timeout\\": 30,\\n \\"WithRequestBody\\": true,\\n \\"WithRematchRoute\\": true,\\n \\"BodyMaxBytes\\": 1024,\\n \\"IsRestrict\\": true,\\n \\"Service\\": {\\n \\"Name\\": \\"updatetime\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"GroupName\\": \\"com.mse.console.test.3YXO\\",\\n \\"Namespace\\": \\"default\\"\\n }\\n },\\n \\"AuthResourceMode\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteGatewayAuth' => [ - 'summary' => '删除网关认证', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateSSLCert' => [ + 'summary' => 'Updates a certificate.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -53474,256 +35830,92 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '37109', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '35702', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The ID of the domain name.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '210', 'title' => ''], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the certificate.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5951436-cn-hangzhou', 'title' => ''], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-2a99625886d54722be94d92e9a69****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '399', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Issuer' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'Jwks' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "keys": ['."\n" - .' {'."\n" - .' "e": "AQAB",'."\n" - .' "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ",'."\n" - .' "kty": "RSA",'."\n" - .' "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - 'IsWhite' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'TokenPosition' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenNamePrefix' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Bearer ', - ], - 'TokenPass' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://yourdomain/path', - ], - 'ClientId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example-app', - ], - 'ClientSecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'CookieDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test.com', - ], - 'ScopesList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'openid', - ], - ], - 'LoginUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CA689BED-08F3-54C2-A206-A0924E2ACA0A'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'Code' => ['description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the update is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA689BED-08F3-54C2-A206-A0924E2ACA0A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateSSLCert', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateSSLCert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 120,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"GatewayId\\": 399,\\n \\"Type\\": \\"JWT\\",\\n \\"Issuer\\": \\"https://example.com/auth\\",\\n \\"Jwks\\": \\"{\\\\n \\\\\\"keys\\\\\\": [\\\\n {\\\\n \\\\\\"e\\\\\\": \\\\\\"AQAB\\\\\\",\\\\n \\\\\\"kid\\\\\\": \\\\\\"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\\\\\\",\\\\n \\\\\\"kty\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"n\\\\\\": \\\\\\"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"IsWhite\\": true,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"TokenPosition\\": \\"HEADER\\",\\n \\"TokenName\\": \\"Authorization\\",\\n \\"TokenNamePrefix\\": \\"Bearer \\",\\n \\"TokenPass\\": true,\\n \\"Status\\": true,\\n \\"RedirectUrl\\": \\"https://yourdomain/path\\",\\n \\"ClientId\\": \\"example-app\\",\\n \\"ClientSecret\\": \\"xxxxx\\",\\n \\"CookieDomain\\": \\"test.com\\",\\n \\"ScopesList\\": [\\n \\"openid\\"\\n ],\\n \\"LoginUrl\\": \\"https://daxxxxcn.aliyunidaas.com/\\"\\n }\\n}","type":"json"}]', ], - 'AddAuthResource' => [ - 'summary' => 'Adds authorization information for a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateServiceSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -53732,216 +35924,88 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '37110', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '24909', + 'abilityTreeNodes' => ['FEATUREmseQRG9VI'], ], 'parameters' => [ [ - 'name' => 'AuthId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the authorization record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '13', - ], + 'schema' => ['description' => 'The ID of the gateway.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '429'], ], [ - 'name' => 'DomainId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '128', - ], + 'schema' => ['description' => 'The type of the service source. Valid values:'."\n" + ."\n" + .'* K8s: ACK cluster.'."\n" + .'* NACOS: Nacos instance.', 'type' => 'string', 'required' => false, 'example' => 'K8s'], ], [ - 'name' => 'Path', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '/abc', - ], + 'schema' => ['description' => 'The service source. Valid values:'."\n" + ."\n" + .'* K8s: ACK cluster.'."\n" + .'* MSE: Nacos instance.', 'type' => 'string', 'required' => false, 'example' => 'K8s'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], + 'schema' => ['description' => 'The address.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c9ad2a0717032427e920754e25b49e3b5'], ], [ - 'name' => 'MatchType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The matching type. Valid values:'."\n" - ."\n" - .'* EQUAL'."\n" - .'* PRE'."\n" - .'* ERGULAR'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'exact', - ], + 'schema' => ['description' => 'The ID of the service source.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '63'], ], [ - 'name' => 'IgnoreCase', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the matching is not case-sensitive. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'istio'], ], [ - 'name' => 'AuthResourceHeaderList', + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gw-cdd1bb9bfb8341e9805f931a3ba1f4c6'], + ], + [ + 'name' => 'IngressOptionsRequest', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The authentication resource headers.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'description' => 'The parameter of the HTTP header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Access-Control-Allow-Origin', - ], - 'HeaderMethod' => [ - 'description' => 'The header matching mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SUFFIX'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* EXIST'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PREFIX'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* EQUAL'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* EXCLUDE'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NOT_EQUAL'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NOT_EXIST'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* REGREX'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* INCLUDE'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SUFFIX' => '', - 'EXIST' => '', - 'PREFIX' => '', - 'EQUAL' => '', - 'EXCLUDE' => '', - 'NOT_EQUAL' => '', - 'NOT_EXIST' => '', - 'REGREX' => '', - 'INCLUDE' => '', - ], - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'description' => 'The parameter value of the HTTP header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - ], - 'required' => false, + 'description' => 'The configurations of Ingress resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => ['description' => 'Specifies whether to enable Ingress.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'IngressClass' => ['description' => 'Specifies whether to monitor Ingress classes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.test.xxx'], + 'WatchNamespace' => ['description' => 'The namespace whose resources you want to monitor.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + 'EnableStatus' => ['description' => 'Specifies whether to update the Ingress status.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'example' => 'zh', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'PathList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', + 'description' => 'An array of service root paths.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The root path of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => '/path'], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese.'."\n" + .'* en: English.', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ @@ -53950,11809 +36014,4004 @@ 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6AB2B0B6-4A86-54E2-A340-FC47A22EE659'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '63'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AB2B0B6-4A86-54E2-A340-FC47A22EE659\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 63\\n}","type":"json"}]', + 'title' => 'UpdateServiceSource', + 'summary' => 'Modifies service sources of a cloud-native gateway. You can modify only Container Service for Kubernetes (ACK) service sources that contain configurations related to Ingress resource monitoring.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7\\",\\n \\"HttpStatusCode\\": 403,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 24\\n}","type":"json"}]', - 'title' => 'AddAuthResource', ], - 'DeleteAuthResource' => [ - 'summary' => 'Deletes an authorized resource.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateWebFlowRule' => [ + 'summary' => 'Updates a hot parameter protection rule for HTTP requests.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '37111', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '164287', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The destination ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '36', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'default', 'example' => 'default', 'title' => ''], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold.', 'type' => 'number', 'format' => 'float', 'required' => false, 'docRequired' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => 'The rule status. Valid values:'."\n" + ."\n" + .'- true (enabled)'."\n" + ."\n" + .'- false (disabled)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Burst', + 'in' => 'query', + 'schema' => ['description' => 'The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens for the token bucket algorithm.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'hkhon1****@c3df23522******', 'title' => ''], + ], + [ + 'name' => 'ControlBehavior', + 'in' => 'query', + 'schema' => ['description' => 'The flow control method. Valid values:'."\n" + ."\n" + .'- 0: fast failure'."\n" + ."\n" + .'- 2: wait in queue', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period. Unit: milliseconds. This parameter is required if the ControlBehavior parameter is set to 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], + ], + [ + 'name' => 'ResourceMode', + 'in' => 'query', + 'schema' => ['description' => 'The resource mode. Valid values:'."\n" + ."\n" + .'- 0: resource name mode', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ParamItem', + 'in' => 'query', + 'schema' => ['description' => 'The parameter description item, which is a JSON string containing the following key-value pairs:'."\n" + ."\n" + .'- parseStrategy: the parameter property (0: client IP address. 1: remote host. 2: header. 3: URL parameter)'."\n" + ."\n" + .'- fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3'."\n" + ."\n" + .'- matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match)'."\n" + ."\n" + .'- pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched', 'type' => 'string', 'required' => false, 'example' => '{"fieldName":"key","matchStrategy":2,"parseStrategy":2,"pattern":"value"}', 'title' => ''], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => ['description' => 'The threshold type. Valid values:'."\n" + ."\n" + .'- 1: number of requests', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => ['description' => 'The length of the time window. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language in which you want the results to be displayed. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.', 'type' => 'string', 'example' => 'zh', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '559412D1-BFCE-53CC-B88E-0192C331EF44', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the primary key.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AuthId' => [ - 'description' => 'The authentication ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '253', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'DomainId' => [ - 'description' => 'The ID of the domain name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/zookeeper', - ], - 'IsWhite' => [ - 'description' => 'Indicates whether the whitelist mode is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'StatIntervalMs' => ['description' => 'The length of the time window. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'spring-cloud-a', 'title' => ''], + 'Resource' => ['description' => 'The interface resource name.', 'type' => 'string', 'example' => '/flow', 'title' => ''], + 'ControlBehavior' => ['description' => 'The flow control method. Valid values:'."\n" + ."\n" + .'- 0: fast failure'."\n" + ."\n" + .'- 2: wait in queue', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ReourceMode' => ['description' => 'The resource mode. Valid values:'."\n" + ."\n" + .'- 0: resource name mode', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MaxQueueingTimeMs' => ['description' => 'The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Threshold' => ['description' => 'The threshold.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + 'Enable' => ['description' => 'The rule status. Valid values:'."\n" + ."\n" + .'- true (enabled)'."\n" + ."\n" + .'- false (disabled)', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'hkhon1XXXX@54e1f42f37cXXXX', 'title' => ''], + 'MetricType' => ['description' => 'The threshold type. Valid values:'."\n" + ."\n" + .'- 1: number of requests', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RegionId' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Burst' => ['description' => 'The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens for the token bucket algorithm.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParamItem' => ['description' => 'The parameter description item, which is a JSON string containing the following key-value pairs:'."\n" + ."\n" + .'- parseStrategy: the parameter property (0: client IP address. 1: remote host. 2: header. 3: URL parameter)'."\n" + ."\n" + .'- fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3'."\n" + ."\n" + .'- matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match)'."\n" + ."\n" + .'- pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched', 'type' => 'string', 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ControlBehavior\\": 0,\\n \\"ReourceMode\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1XXXX@54e1f42f37cXXXX\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Burst\\": 0,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateWebFlowRule', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"559412D1-BFCE-53CC-B88E-0192C331EF44\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"AuthId\\": 253,\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 0,\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"name\\",\\n \\"Path\\": \\"/zookeeper\\",\\n \\"IsWhite\\": true,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteAuthResource', ], - 'AddGatewayRoute' => [ - 'summary' => 'Adds a gateway route.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateZnode' => [ + 'summary' => 'Updates the information about a ZooKeeper node.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '25612', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '17105', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '526', - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****', 'title' => ''], ], [ - 'name' => 'RouteOrder', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The sequence number of the route. (A small value indicates a high priority.)'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The path of the node.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper', 'title' => ''], ], [ - 'name' => 'Predicates', + 'name' => 'Data', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The data of the node.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'data', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The matching rule.'."\n", + 'description' => 'The data structure.'."\n", 'type' => 'object', 'properties' => [ - 'PathPredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'Type' => [ - 'description' => 'The route matching type. Valid values:'."\n" - ."\n" - .'* PRE: prefix matching'."\n" - .'* EQUAL: exact matching'."\n" - .'* ERGULAR: regular expression matching'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => 'Specifies whether to ignore case sensitivity.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'MethodPredicates' => [ - 'description' => 'The information about method matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'required' => false, - ], - 'HeaderPredicates' => [ - 'description' => 'The information about header matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request header.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'debug', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'QueryPredicates' => [ - 'description' => 'The information about URL parameter matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the URL parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'userid', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => 'The current ZooKeeper operation is invalid, please recheck and perform the operation.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => 'No permission to operate the current node.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => 'The current node already exists. Please check and try again.'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => 'The currently operating node does not exist and may have been deleted.'], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper the operation times out, it may be because the current Znode data is too large, there are too many child nodes, the server takes too long to process the request, or the cluster is currently selecting a host and cannot process the request.'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateZnode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'UpdateZooKeeperSaslUser' => [ + 'summary' => 'Updates a ZooKeeper Simple Authentication and Security Layer (SASL) user.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217282', + 'abilityTreeNodes' => ['FEATUREmse2TF2YB'], + ], + 'parameters' => [ [ - 'name' => 'Services', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mse_prepaid_public_cn-tl327w****'], + ], + [ + 'name' => 'SaslUser', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The list of services.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The list of services.'."\n", 'type' => 'object', 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '353', - ], - 'Percent' => [ - 'description' => 'The weight in the form of a percentage value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => 'The type of the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO', - ], - 'HttpDubboTranscoder' => [ - 'description' => 'The transcoder of the Dubbo protocol.'."\n", - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'The name of the Dubbo service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', - ], - 'DubboServiceVersion' => [ - 'description' => 'The version of the Dubbo service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0', - ], - 'DubboServiceGroup' => [ - 'description' => 'The name of the service group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'None'."\n", - ], - 'MothedMapList' => [ - 'description' => 'The forwarding rules of the Dubbo service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method mapping.'."\n", - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'The method name of the Dubbo service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'The HTTP method.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* ALL_GET'."\n" - ."\n" - .'* ALL_POST'."\n" - ."\n" - .'* ALL_PUT'."\n" - ."\n" - .'* ALL_DELETE'."\n" - ."\n" - .'* ALL_PATCH'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => 'The path used for method matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/mytestzbk/sayhello', - ], - 'PassThroughAllHeaders' => [ - 'description' => 'The pass-through type of the header.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* PASS_ALL: All headers are passed through.'."\n" - ."\n" - .'* PASS_NOT: All headers are not passed through.'."\n" - ."\n" - .'* PASS_ASSIGN: Specified headers are passed through.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PASS_NOT', - ], - 'PassThroughList' => [ - 'description' => 'The list of headers to be passed through.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the header to be passed through.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x-forward', - ], - 'required' => false, - ], - 'ParamMapsList' => [ - 'description' => 'The information about parameter mappings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter mapping object.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => 'The position of the input parameter.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* `ALL_QUERY_PARAMETER`: request parameter'."\n" - ."\n" - .'* `ALL_HEADER`: request header'."\n" - .'* `ALL_PATH`: request path'."\n" - .'* `ALL_BODY`: request body'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_QUERY_PARAMETER', - ], - 'ExtractKey' => [ - 'description' => 'The key extracted from the input parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => 'The type of the backend service parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'java.lang.String', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ServicePort' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', - ], + 'UserName' => ['description' => 'The user name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test'], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxxxx'], + 'Description' => ['description' => 'A description for the user.', 'type' => 'string', 'maxLength' => 128, 'title' => '', 'required' => false, 'example' => 'test'], + 'OriginPassword' => ['description' => 'The original password. This parameter is required to change the password.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'origin-password'], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - ], - [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', + 'required' => true, + 'title' => '', + 'description' => 'The list of users to update.', + 'example' => '', ], ], [ - 'name' => 'DestinationType', + 'name' => 'Reload', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the destination service. Valid values:'."\n" - ."\n" - .'* Single'."\n" - .'* Multiple'."\n" - .'* VersionOriented'."\n" - .'* Mock'."\n" - .'* Redirect'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'VersionOriented' => 'VersionOriented', - 'Multiple' => 'Multiple', - 'Single' => 'Single', - 'Redirect' => 'Redirect', - 'Mock' => 'Mock', - ], - 'example' => 'Multiple', - ], + 'schema' => ['description' => 'Specifies whether the changes take effect immediately.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], - [ - 'name' => 'DirectResponseJSON', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The mock response configuration.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The mock return code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '403', - ], - 'Body' => [ - 'description' => 'The mock return value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'description' => 'RestResult\\', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateZooKeeperSaslUser', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be8*****', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'UpgradeCluster' => [ + 'summary' => 'Upgrades the version of a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'DomainIdListJSON', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[0,94]', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'RedirectJSON', + 'name' => 'RequestPars', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration of the redirection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '302', - ], - 'Host' => [ - 'description' => 'The hostname to be redirected to.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], - 'Path' => [ - 'description' => 'The path to be redirected to.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The extended request parameters in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'EnableWaf', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'deprecated' => true, - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-nif1w51wi0c', 'title' => ''], ], [ - 'name' => 'Fallback', + 'name' => 'UpgradeVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the Fallback service.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The destination version.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.2.1', 'title' => ''], ], [ - 'name' => 'FallbackServices', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about the Fallback service.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '353', - ], - 'Percent' => [ - 'description' => 'The weight in the form of a percentage value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => 'The type of the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO', - ], - 'ServicePort' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', - ], - ], - 'required' => false, + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", 'type' => 'string', 'example' => 'The request is processed successfully.', 'title' => ''], + 'HttpCode' => ['description' => 'The response code returned.'."\n", 'type' => 'string', 'example' => '202', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D855418-177B-5FF8-A021-75B930AD890A', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mse-100-000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => 'Invalid request: %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => 'Request parameter error: %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => 'You do not have the permission to use this interface:%s'], + ], [ - 'name' => 'RouteType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The route type. Valid values:'."\n" - ."\n" - .'Op: Manage routes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Op', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => 'The resource does not exist:%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => 'Console error. Try again later: %s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"8D855418-177B-5FF8-A021-75B930AD890A\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpgradeCluster', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Policies', - 'in' => 'query', - 'schema' => [ - 'description' => 'The routing policy in a JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"CORS":"{\\"allowMethods\\":\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\"allowHeaders\\":\\"*\\",\\"exposeHeaders\\":\\"*\\",\\"unitNum\\":12,\\"allowCredentials\\":true,\\"status\\":\\"off\\",\\"allowOrigins\\":\\"*\\",\\"timeUnit\\":\\"h\\"}","Timeout":"{\\"unitNum\\":10,\\"timeUnit\\":\\"s\\",\\"status\\":\\"off\\"}","Retry":"{\\"attempts\\":2,\\"retryOn\\":[\\"5xx\\"],\\"status\\":\\"off\\"}","HTTPRewrite":"{\\"pathType\\":\\"EQUAL\\",\\"path\\":\\"/o\\",\\"status\\":\\"off\\"}","Waf":"{\\"enabled\\":false}","HeaderOp":"{\\"status\\":\\"off\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Add\\",\\"key\\":\\"kkk\\",\\"value\\":\\"ll\\"}]}"}', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpgradeCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '路由描述', - 'type' => 'string', - 'example' => 'a route for xxx', + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'mse.cn-wulanchabu.aliyuncs.com', 'vpc' => 'mse-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-beijing.aliyuncs.com', 'endpoint' => 'mse.cn-beijing.aliyuncs.com', 'vpc' => 'mse-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'mse.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'mse-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-qingdao.aliyuncs.com', 'endpoint' => 'mse.cn-qingdao.aliyuncs.com', 'vpc' => 'mse-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'mse.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'mse-vpc.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-shanghai.aliyuncs.com', 'endpoint' => 'mse.cn-shanghai.aliyuncs.com', 'vpc' => 'mse-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-hongkong.aliyuncs.com', 'endpoint' => 'mse.cn-hongkong.aliyuncs.com', 'vpc' => 'mse-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-heyuan.aliyuncs.com', 'endpoint' => 'mse.cn-heyuan.aliyuncs.com', 'vpc' => 'mse-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'mse.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-shenzhen.aliyuncs.com', 'endpoint' => 'mse.cn-shenzhen.aliyuncs.com', 'vpc' => 'mse-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-northeast-2.aliyuncs.com', 'endpoint' => 'mse.ap-northeast-2.aliyuncs.com', 'vpc' => 'mse-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-northeast-1.aliyuncs.com', 'endpoint' => 'mse.ap-northeast-1.aliyuncs.com', 'vpc' => 'mse-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-fuzhou.aliyuncs.com', 'endpoint' => 'mse.cn-fuzhou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-chengdu.aliyuncs.com', 'endpoint' => 'mse.cn-chengdu.aliyuncs.com', 'vpc' => 'mse-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-guangzhou.aliyuncs.com', 'endpoint' => 'mse.cn-guangzhou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-southeast-1.aliyuncs.com', 'endpoint' => 'mse.ap-southeast-1.aliyuncs.com', 'vpc' => 'mse-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-southeast-3.aliyuncs.com', 'endpoint' => 'mse.ap-southeast-3.aliyuncs.com', 'vpc' => 'mse-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-huhehaote.aliyuncs.com', 'endpoint' => 'mse.cn-huhehaote.aliyuncs.com', 'vpc' => 'mse-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-southeast-5.aliyuncs.com', 'endpoint' => 'mse.ap-southeast-5.aliyuncs.com', 'vpc' => 'mse-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-southeast-6.aliyuncs.com', 'endpoint' => 'mse.ap-southeast-6.aliyuncs.com', 'vpc' => 'mse-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.ap-southeast-7.aliyuncs.com', 'endpoint' => 'mse.ap-southeast-7.aliyuncs.com', 'vpc' => 'mse-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mse.cn-hangzhou.aliyuncs.com', 'endpoint' => 'mse.cn-hangzhou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mse.us-east-1.aliyuncs.com', 'endpoint' => 'mse.us-east-1.aliyuncs.com', 'vpc' => 'mse-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mse.eu-west-1.aliyuncs.com', 'endpoint' => 'mse.eu-west-1.aliyuncs.com', 'vpc' => 'mse-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mse.us-west-1.aliyuncs.com', 'endpoint' => 'mse.us-west-1.aliyuncs.com', 'vpc' => 'mse-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mse.eu-central-1.aliyuncs.com', 'endpoint' => 'mse.eu-central-1.aliyuncs.com', 'vpc' => 'mse-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'mse.me-east-1.aliyuncs.com', 'endpoint' => 'mse.me-east-1.aliyuncs.com', 'vpc' => 'mse-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'mse.me-central-1.aliyuncs.com', 'endpoint' => 'mse.me-central-1.aliyuncs.com', 'vpc' => 'mse-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'mse.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'mse.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'mse-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'mse.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'mse.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'mse-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'mse.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'mse.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'mse-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'mse.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'mse.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'mse-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'clusterNotFound', 'message' => 'cluster not found', 'http_code' => 404, 'description' => 'The cluster is not found.'], + ['code' => 'configCenterConnectError', 'message' => 'configCenter connect error:%s', 'http_code' => 400, 'description' => 'Failed to connect to the MSE instance: %s'], + ['code' => 'duplicatedClusterAliasName', 'message' => 'duplicated cluster alias name', 'http_code' => 400, 'description' => 'The instance name is duplicate. User another name.'], + ['code' => 'illegalRequest', 'message' => 'illegal request:%s', 'http_code' => 400, 'description' => 'Invalid request: %s'], + ['code' => 'IllegalRequest', 'message' => 'Invalid request:%s', 'http_code' => 400, 'description' => 'Invalid request: %s'], + ['code' => 'InternalError', 'message' => 'Console error. Try again later:%s', 'http_code' => 500, 'description' => 'Console error. Try again later: %s'], + ['code' => 'InvalidParameter', 'message' => 'Parameter error:%s', 'http_code' => 400, 'description' => 'Request parameter error: %s'], + ['code' => 'InvalidResourceGroup', 'message' => 'The specified ResourceGroupId is invalid.', 'http_code' => 400, 'description' => 'Resource group is invalid'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation:%s', 'http_code' => 403, 'description' => 'You do not have the permission to use this interface:%s'], + ['code' => 'NotFound', 'message' => 'Not found:%s', 'http_code' => 404, 'description' => 'The resource does not exist:%s'], + ['code' => 'OperationNotSupport', 'message' => 'The current cluster does not support this operation, %s.', 'http_code' => 400, 'description' => 'The current cluster does not support this operation, %s'], + ['code' => 'PARAMETER.ILLEGALL', 'message' => 'Parameters are invalid.', 'http_code' => 400, 'description' => 'The error code specified by the quota center callback Mse, the API call parameter is abnormal.'], + ['code' => 'QUOTA.NOT.FOUND', 'message' => 'Quota not found.', 'http_code' => 404, 'description' => 'Quota does not exist'], + ['code' => 'regcenterError', 'message' => 'register center error:%s', 'http_code' => 500, 'description' => 'Instance request error: %s'], + ['code' => 'Resource.exist', 'message' => 'Resource %s already exists, cannot be created repeatedly.', 'http_code' => 400, 'description' => 'Resource already exists, cannot be created repeatedly'], + ['code' => 'systemError', 'message' => 'system error', 'http_code' => 500, 'description' => 'An error occurred on the system. Try again later.'], + ['code' => 'ZooKeeper.IllegalRequest', 'message' => 'ZooKeeper operation is illegal.', 'http_code' => 400, 'description' => 'The current ZooKeeper operation is invalid, please recheck and perform the operation.'], + ['code' => 'ZooKeeper.IllegalRequest.NoAuth', 'message' => 'No permission to operate current Znode.', 'http_code' => 400, 'description' => 'No permission to operate the current node.'], + ['code' => 'ZooKeeper.IllegalRequest.NodeExist', 'message' => 'The current instance already has this Znode.', 'http_code' => 400, 'description' => 'The current node already exists. Please check and try again.'], + ['code' => 'ZooKeeper.IllegalRequest.NoNode', 'message' => 'The current instance does not have this Znode.', 'http_code' => 400, 'description' => 'The currently operating node does not exist and may have been deleted.'], + ['code' => 'ZooKeeper.Timeout', 'message' => 'ZooKeeper operation timeout.', 'http_code' => 400, 'description' => 'ZooKeeper the operation times out, it may be because the current Znode data is too large, there are too many child nodes, the server takes too long to process the request, or the cluster is currently selecting a host and cannot process the request.'], + ['code' => 'Nacos.InterceptByGreen', 'message' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry. The blocking reason is %s and the blocking content is %s.', 'http_code' => 400, 'description' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry. The blocking reason is %s and the blocking content is %s.'], + ['code' => 'Nacos.Intercepted', 'message' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry.', 'http_code' => 400, 'description' => 'The request is detected and intercepted by the security fence. Check the request content and modify the request again. The interception details are %s.'], + ['code' => 'PromptNotSupported', 'message' => 'The current instance does not support prompt registry.', 'http_code' => 400, 'description' => 'The current instance does not support the Prompt Registry.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetGatewayConfig'], + ], + 'createdAt' => '2026-06-30T13:59:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetGatewayConfig'], + ], + 'createdAt' => '2026-06-30T13:57:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetGatewayConfig'], + ], + 'createdAt' => '2026-06-30T13:57:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetGatewayConfig'], + ], + 'createdAt' => '2026-06-30T08:46:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddGatewayDomain'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateGatewayDomain'], + ['description' => 'OpenAPI offline', 'api' => 'GetGatewayDomainDetail'], + ], + 'createdAt' => '2026-03-12T02:35:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetGatewayDomainDetail'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateGatewayDomain'], + ['description' => 'OpenAPI offline', 'api' => 'AddGatewayDomain'], + ], + 'createdAt' => '2026-03-03T08:16:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryBusinessLocations'], + ['description' => 'OpenAPI offline', 'api' => 'QueryBusinessLocations'], + ], + 'createdAt' => '2026-02-27T05:54:51.000Z', + 'description' => '', + ], + ], + 'ram' => [ + 'productCode' => 'MSE', + 'productName' => 'Microservices Engine', + 'ramCodes' => ['mse', 'microgw'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'QueryZnodeDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryZnodeDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'QueryGatewayType', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The ID of the created route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '555', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n" - ."\n" - .'* InvalidParameter: The parameter is invalid. For example, the parameter is incomplete or the parameter format is invalid.'."\n" - .'* IllegalRequest: The request is invalid. Unauthorized access to data initiated by parameters is identified.'."\n" - .'* NoPermission: You are not authorized to perform this operation.'."\n" - .'* NotFound: The resource does not exist and error 404 is returned.'."\n" - .'* InternalError: An internal error occurred.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - ], + [ + 'apiName' => 'GetServiceList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'GetNacosConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'FetchLosslessRuleList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:FetchLosslessRuleList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'DeleteBlackWhiteList', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'GetTagsBySwimmingLaneGroupId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetTagsBySwimmingLaneGroupId', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'GetMseSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 555,\\n \\"ErrorCode\\": \\"InvalidParameter\\"\\n}","type":"json"}]', - 'title' => 'AddGatewayRoute', - ], - 'DeleteGatewayRoute' => [ - 'summary' => 'Deletes a route from a gateway.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'UpdateSSLCert', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateSSLCert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListInstanceCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListInstanceCount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'gateway', + [ + 'apiName' => 'ListAppBySwimmingLaneGroupTag', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTag', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateGatewayDomain', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '25970', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', + [ + 'apiName' => 'UpdateGatewayRouteAuth', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '252', + [ + 'apiName' => 'DeleteSwimmingLane', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7', + ], + [ + 'apiName' => 'CloneSentinelRuleFromAhas', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneSentinelRuleFromAhas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'DeleteNacosConfig', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14cebbrvec4a5****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '125', - ], - 'Predicates' => [ - 'description' => 'The matching rules.'."\n", - 'type' => 'string', - 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', - ], - 'DefaultServiceId' => [ - 'description' => 'The default service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RouteOrder' => [ - 'description' => 'The sequence number of the route.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'The status of the route. Valid values:'."\n" - ."\n" - .'* 0: unpublished'."\n" - .'* 2: publishing'."\n" - .'* 3: published'."\n" - .'* 4: editing (updated but not published)'."\n" - .'* 5: unpublishing'."\n" - .'* 6: unavailable'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2021-12-30T06:41:52.000+0000', - ], - ], - ], - ], + [ + 'apiName' => 'GetOverview', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:GetOverview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'ListSSLCert', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListSSLCert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'DeleteGatewayRoute', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListGatewayFlowRule', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'UpdateConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'ImportServices', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebbrvec4a5****\\",\\n \\"GatewayId\\": 125,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/metas\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":false}}\\",\\n \\"DefaultServiceId\\": 1,\\n \\"RouteOrder\\": 1,\\n \\"Status\\": 2,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2021-12-30T06:41:52.000+0000\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteGatewayRoute', - ], - 'UpdateGatewayRouteHTTPRewrite' => [ - 'summary' => 'Updates the rewrite policy of a route for a gateway.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdateGatewayAuthConsumerResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumerResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetGatewayRouteDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayRouteDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'tags' => [ - 'gateway', + [ + 'apiName' => 'QuerySwimmingLaneById', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QuerySwimmingLaneById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateIsolationRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateNacosInstance', + 'description' => '', 'operationType' => 'update', - 'abilityTreeCode' => '59359', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '238', + [ + 'apiName' => 'ListGatewayAuthConsumerResource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListGatewayAuthConsumerResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '430', + ], + [ + 'apiName' => 'ListGatewayIsolationRule', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'HttpRewriteJSON', - 'in' => 'query', - 'schema' => [ - 'description' => 'The information about the rewrite policy. The JSON format is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"pathType":"PRE","path":"/","status":"off"}', + ], + [ + 'apiName' => 'DeleteIsolationRules', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-90392d768a3847a7b804c505254da96d', + ], + [ + 'apiName' => 'DeleteCluster', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'DeleteSecurityGroupRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AE60DA1E-B234-5105-897B-68372453A5A2', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '411', - ], - ], + [ + 'apiName' => 'UpdateGatewayRouteTimeout', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteTimeout', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'GetImportFileUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetImportFileUrl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'AddGateway', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListClusterTypes', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'ListZkTrack', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZkTrack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'UpdateMigrationTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE60DA1E-B234-5105-897B-68372453A5A2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 411\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteHTTPRewrite', - ], - 'UpdateGatewayRoute' => [ - 'summary' => 'Updates a route for a gateway.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteGatewayAuthConsumerResource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayAuthConsumerResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListClusterHealthCheckTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterHealthCheckTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'gateway', + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetLocalityRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLocalityRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryClusterInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListIsolationRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteGatewayDomain', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'QueryMonitor', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddAuthPolicy', + 'description' => '', 'operationType' => 'update', - 'abilityTreeCode' => '25973', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', + 'ramAction' => [ + 'action' => 'mse:AddAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '501', + [ + 'apiName' => 'AddGatewaySlb', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'route-web', - 'title' => '路由名称（已废弃，不支持修改路由名称，填入和当前不同的路由名称会导致更新失败）', - 'deprecated' => true, + ], + [ + 'apiName' => 'DeleteEngineNamespace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RouteOrder', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sequence number of the route.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'UpdateGatewayRoute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'Predicates', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The route matching conditions.'."\n", - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => 'The information about path matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The path used for route matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => 'Specifies whether to perform case-insensitive matching.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - 'MethodPredicates' => [ - 'description' => 'The information about method matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'required' => false, - ], - 'HeaderPredicates' => [ - 'description' => 'The information about header matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request header.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'debug', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'QueryPredicates' => [ - 'description' => 'The information about parameter matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a URL parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'userid', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'Services', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about destination services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The services.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Percent' => [ - 'description' => 'The percentage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'web', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace in which the service resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => 'The type of the protocol. Valid values:'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO'."\n", - ], - 'HttpDubboTranscoder' => [ - 'description' => 'The transcoder of the Dubbo protocol.'."\n", - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'The name of the Dubbo service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', - ], - 'DubboServiceVersion' => [ - 'description' => 'The version of the Dubbo service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0', - ], - 'DubboServiceGroup' => [ - 'description' => 'The Dubbo service group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'service name', - ], - 'MothedMapList' => [ - 'description' => 'The forwarding rules of the Dubbo service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method mapping object.'."\n", - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'The method name of the Dubbo service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'The HTTP method.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* ALL_GET'."\n" - ."\n" - .'* ALL_POST'."\n" - ."\n" - .'* ALL_PUT'."\n" - ."\n" - .'* ALL_DELETE'."\n" - ."\n" - .'* ALL_PATCH'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => 'The path that is used to match a method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/mytestzbk/sayhello'."\n", - ], - 'PassThroughAllHeaders' => [ - 'description' => 'The pass-through type of the header.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* PASS_ALL: All headers are passed through.'."\n" - ."\n" - .'* PASS_NOT: All headers are not passed through.'."\n" - ."\n" - .'* PASS_ASSIGN: Specified headers are passed through.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PASS_NOT'."\n", - ], - 'PassThroughList' => [ - 'description' => 'The list of headers to be passed through.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the header to be passed through.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x-forward'."\n", - ], - 'required' => false, - ], - 'ParamMapsList' => [ - 'description' => 'The information of parameter mappings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter mapping object.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => 'The position of the input parameter.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* `ALL_QUERY_PARAMETER`: request parameter'."\n" - ."\n" - .'* `ALL_HEADER`: request header'."\n" - ."\n" - .'* `ALL_PATH`: request path'."\n" - ."\n" - .'* `ALL_BODY`: request body'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_QUERY_PARAMETER'."\n", - ], - 'ExtractKey' => [ - 'description' => 'The key extracted from the input parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => 'The type of the backend service parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'java.lang.String', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ServicePort' => [ - 'description' => 'The Dubbo port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20880', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '139', - ], - ], - [ - 'name' => 'DestinationType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The destination service type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Mock', - ], - ], - [ - 'name' => 'DirectResponseJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about service mocking.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The mock return code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'Body' => [ - 'description' => 'The mock return value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392a2c4', - ], - ], - [ - 'name' => 'DomainIdListJSON', - 'in' => 'query', - 'schema' => [ - 'description' => 'The associated domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[90]', - ], - ], - [ - 'name' => 'RedirectJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about redirection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '302', - ], - 'Host' => [ - 'description' => 'The hostname to be redirected to.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], - 'Path' => [ - 'description' => 'The path to be redirected to.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnableWaf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '请使用UpdateGatewayRouteWafStatus更新路由WAF状态', - 'deprecated' => true, - ], - ], - [ - 'name' => 'Fallback', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the Fallback service.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'FallbackServices', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the Fallback service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data object.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Percent' => [ - 'description' => 'The weight in the form of a percentage value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace in which the service resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Namespace'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => 'The type of the protocol. Valid values:'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO'."\n", - ], - 'ServicePort' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8848', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '路由描述', - 'type' => 'string', - 'example' => 'a route for xxx', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '73785414-2C5B-5E28-BD91-B2C742269C48', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '337', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73785414-2C5B-5E28-BD91-B2C742269C48\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 337,\\n \\"ErrorCode\\": \\"NoPermission\\"\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRoute', - ], - 'UpdateGatewayRouteCORS' => [ - 'summary' => 'Modifies the cross-origin resource sharing (CORS) policy of a route.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '101484', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the associated record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '55', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '85', - ], - ], - [ - 'name' => 'CorsJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the CORS policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - 'AllowOrigins' => [ - 'description' => 'The origins from which access is allowed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://api.aliyun-inc.com/', - ], - 'AllowMethods' => [ - 'description' => 'The HTTP methods allowed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET,POST', - ], - 'AllowHeaders' => [ - 'description' => 'The request headers allowed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'content-type', - ], - 'ExposeHeaders' => [ - 'description' => 'The response headers allowed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'TimeUnit' => [ - 'description' => 'The unit of time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'h', - ], - 'UnitNum' => [ - 'description' => 'The value of time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24', - ], - 'AllowCredentials' => [ - 'description' => 'The credentials allowed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-f70a6ddf2f0941a2bb997b2d16028f37', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. In compliance with [RFC 7231](https://tools.ietf.org/html/rfc7231), the backend service must return a response based on the language used by the user.'."\n" - ."\n" - .'* No default value.'."\n" - .'* zh-CN: Chinese'."\n" - .'* en-US: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '41BE990E-44E4-5ED3-AEEB-A276941B1854', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. ', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '618', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41BE990E-44E4-5ED3-AEEB-A276941B1854\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. \\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 618\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteCORS', - ], - 'UpdateGatewayRouteHeaderOp' => [ - 'summary' => 'Modifies the header configuration policy of a route.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '72158', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '411', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '324', - ], - ], - [ - 'name' => 'HeaderOpJSON', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of user header settings.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"status\\":\\"on\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Update\\",\\"key\\":\\"hosts\\",\\"value\\":\\"test.com\\"}]}', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-6bdc977deda44bf589c49d063b4c2d1d', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7C8CB294-BED8-5F32-A416-7517725E8F27', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '666', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C8CB294-BED8-5F32-A416-7517725E8F27\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 666\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteHeaderOp', - ], - 'UpdateGatewayRouteTimeout' => [ - 'summary' => 'Modifies the timeout policy of a route.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '114050', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the associated record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '567', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '85', - ], - ], - [ - 'name' => 'TimeoutJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'description' => 'The value of the timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'TimeUnit' => [ - 'description' => 'The unit of time. A value of s indicates seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's', - ], - 'Status' => [ - 'description' => 'The status of the policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-533290d279c1405f9628c64f7c8272ee', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5359729E-A059-5942-98AF-E981E89C99FA', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '400', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5359729E-A059-5942-98AF-E981E89C99FA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 400\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteTimeout', - ], - 'UpdateGatewayRouteRetry' => [ - 'summary' => 'Modifies the retry policy of a route.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '114051', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the associated record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '508', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '501', - ], - ], - [ - 'name' => 'RetryJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the retry policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Attempts' => [ - 'description' => 'The number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'RetryOn' => [ - 'description' => 'The retry conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retry condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5xx', - ], - 'required' => false, - ], - 'HttpCodes' => [ - 'description' => 'The HTTP status codes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - ], - 'Status' => [ - 'description' => 'The status of the policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1d10a', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '640', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9297B27D-D932-5E9F-93B9-99D6C5F3A879\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 640\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteRetry', - ], - 'GetGatewayRouteDetail' => [ - 'summary' => 'Queries the details of a route for a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1050', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-5d3a78a53ec947aa928212d671d400ac', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FDF2D16C-5D28-5FAA-A56B-30BDE3559880', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1050', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DefaultServiceId' => [ - 'description' => 'The default service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'DefaultServiceName' => [ - 'description' => 'The default service name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => 'The status of the route. Valid values:'."\n" - ."\n" - .'* 0: unpublished'."\n" - .'* 2: publishing'."\n" - .'* 3: published'."\n" - .'* 4: editing (updated but not published)'."\n" - .'* 5: unpublishing'."\n" - .'* 6: unavailable'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'RouteOrder' => [ - 'description' => 'The sequence number of the route.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Predicates' => [ - 'description' => 'The matching conditions.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'RoutePredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/api', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => 'Indicates whether case sensitivity is ignored.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'MethodPredicates' => [ - 'description' => 'The information about method matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'HeaderPredicates' => [ - 'description' => 'The information about header matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request header.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the request header.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Type' => [ - 'description' => 'The route type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - 'QueryPredicates' => [ - 'description' => 'The information about parameter matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'userid', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The route type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => '123.com', - ], - 'Services' => [ - 'description' => 'The configurations of services.'."\n", - 'type' => 'string', - 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', - ], - 'RouteServices' => [ - 'description' => 'The services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The services.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '782', - ], - 'ServiceName' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'xkc-crm', - ], - 'Percent' => [ - 'description' => 'The weight.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The service version.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'dubbo4', - ], - 'SourceType' => [ - 'description' => 'The source type of the service.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'api', - ], - 'AgreementType' => [ - 'description' => 'The protocol type.'."\n", - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'HttpDubboTranscoder' => [ - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'type' => 'string', - ], - 'DubboServiceVersion' => [ - 'type' => 'string', - ], - 'MothedMapList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'type' => 'string', - ], - 'HttpMothed' => [ - 'type' => 'string', - ], - 'Mothedpath' => [ - 'type' => 'string', - ], - 'PassThroughAllHeaders' => [ - 'type' => 'string', - ], - 'PassThroughList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ParamMapsList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'type' => 'string', - ], - 'ExtractKey' => [ - 'type' => 'string', - ], - 'MappingType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'DubboServiceGroup' => [ - 'type' => 'string', - ], - ], - ], - 'ServicePort' => [ - 'description' => 'The port number of the service.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20880', - ], - 'HealthStatus' => [ - 'title' => '健康状态'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Checking'."\n" - ."\n" - .'- Unknown', - 'type' => 'string', - 'example' => 'Health', - ], - 'UnhealthyEndpoints' => [ - 'title' => '非健康Endpoint列表', - 'type' => 'array', - 'items' => [ - 'title' => '非健康Endpoint', - 'type' => 'string', - 'example' => '192.168.1.2', - ], - ], - ], - ], - ], - 'HTTPRewrite' => [ - 'description' => 'The information about the rewrite policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the policy.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'Path' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'example' => '/test/client', - ], - 'Host' => [ - 'description' => 'The hostname of the gateway.'."\n", - 'type' => 'string', - 'example' => 'aliyuncs.com', - ], - 'PathType' => [ - 'description' => 'The rewrite type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - 'Pattern' => [ - 'description' => 'The matching pattern.'."\n", - 'type' => 'string', - 'example' => '/test', - ], - 'Substitution' => [ - 'description' => 'The replacement.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'HeaderOp' => [ - 'description' => 'The header settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'HeaderOpItems' => [ - 'description' => 'The information about headers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'DirectionType' => [ - 'description' => 'The request or response.'."\n", - 'type' => 'string', - 'example' => 'Response', - ], - 'OpType' => [ - 'description' => 'The type of the operation.'."\n", - 'type' => 'string', - 'example' => 'Add', - ], - 'Key' => [ - 'description' => 'The header key.'."\n", - 'type' => 'string', - 'example' => 'debug', - ], - 'Value' => [ - 'description' => 'The header value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - 'DestinationType' => [ - 'description' => 'The destination service type.'."\n", - 'type' => 'string', - 'example' => 'Single', - ], - 'DirectResponse' => [ - 'description' => 'The information about service mocking.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Body' => [ - 'description' => 'The mock return value.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - ], - ], - 'Cors' => [ - 'description' => 'The configuration for cross-origin resource sharing (CORS).'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'AllowOrigins' => [ - 'description' => 'The origins allowed.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'AllowMethods' => [ - 'description' => 'The methods allowed.'."\n", - 'type' => 'string', - 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', - ], - 'AllowHeaders' => [ - 'description' => 'The headers allowed.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'ExposeHeaders' => [ - 'description' => 'The response headers.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'TimeUnit' => [ - 'description' => 'The time unit.'."\n", - 'type' => 'string', - 'example' => 'h', - ], - 'UnitNum' => [ - 'description' => 'The unit number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'AllowCredentials' => [ - 'description' => 'The credentials allowed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Timeout' => [ - 'description' => 'The timeout configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'description' => 'The unit number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TimeUnit' => [ - 'description' => 'The time unit.'."\n", - 'type' => 'string', - 'example' => 's', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - ], - ], - 'Retry' => [ - 'description' => 'The retry configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Attempts' => [ - 'description' => 'The number of retries allowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RetryOn' => [ - 'description' => 'The retry condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retry condition.'."\n", - 'type' => 'string', - 'example' => '5xx', - ], - ], - 'HttpCodes' => [ - 'description' => 'The HTTP status codes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '500', - ], - ], - 'Status' => [ - 'description' => 'The retry status.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - ], - ], - 'DomainIdList' => [ - 'description' => 'The IDs of domains.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of domains.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'DomainNameList' => [ - 'description' => 'The list of domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of domain names.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - ], - 'Redirect' => [ - 'description' => 'The configuration of the redirection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Host' => [ - 'description' => 'The hostname.'."\n", - 'type' => 'string', - 'example' => '16', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '10111', - ], - ], - ], - 'FlowMirror' => [ - 'description' => '流量镜像配置。', - 'type' => 'object', - 'properties' => [ - 'TargetServiceId' => [ - 'description' => '目标服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'TargetServiceName' => [ - 'description' => '目标服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Port' => [ - 'description' => '目标服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8790', - ], - 'Percentage' => [ - 'description' => '流量复制比例（%），取值0-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'Status' => [ - 'description' => '开启状态，取值：'."\n" - ."\n" - .'- on：开启'."\n" - .'- off：关闭', - 'type' => 'string', - 'example' => 'on', - ], - ], - ], - 'EnableWaf' => [ - 'description' => 'Indicates whether Web Application Firewall (WAF) is activated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AhasStatus' => [ - 'description' => 'The status of Application High Availability Service (AHAS).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Fallback' => [ - 'description' => 'Indicates whether the Fallback service is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FallbackServices' => [ - 'description' => 'The information of the Fallback service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data object.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceName' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Percent' => [ - 'description' => 'The weight in the form of a percentage value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The service version.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'SourceType' => [ - 'description' => 'The source type of the service.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'namespace', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => 'The protocol type.'."\n", - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'ServicePort' => [ - 'description' => 'The port number of the service.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8848', - ], - ], - ], - ], - 'Policies' => [ - 'description' => 'The routing policy in a JSON string.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "CORS": "{\\"allowMethods\\":\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\"allowHeaders\\":\\"*\\",\\"exposeHeaders\\":\\"*\\",\\"unitNum\\":12,\\"allowCredentials\\":true,\\"status\\":\\"off\\",\\"allowOrigins\\":\\"*\\",\\"timeUnit\\":\\"h\\"}",'."\n" - .' "Timeout": "{\\"unitNum\\":10,\\"timeUnit\\":\\"s\\",\\"status\\":\\"off\\"}",'."\n" - .' "Retry": "{\\"attempts\\":2,\\"retryOn\\":[\\"5xx\\"],\\"status\\":\\"off\\"}",'."\n" - .' "HTTPRewrite": "{\\"pathType\\":\\"EQUAL\\",\\"path\\":\\"/o\\",\\"status\\":\\"off\\"}",'."\n" - .' "Waf": "{\\"enabled\\":false}",'."\n" - .' "HeaderOp": "{\\"status\\":\\"off\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Add\\",\\"key\\":\\"kkk\\",\\"value\\":\\"ll\\"}]}"'."\n" - .'}', - ], - 'Description' => [ - 'title' => '路由描述', - 'type' => 'string', - 'example' => 'a route for xxx', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FDF2D16C-5D28-5FAA-A56B-30BDE3559880\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1050,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"DefaultServiceId\\": 3,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"Status\\": 0,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"RouteOrder\\": 1,\\n \\"Predicates\\": \\"{}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/api\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"200\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"123.com\\",\\n \\"Services\\": \\"[{\\\\\\\\\\\\\\"Percent\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"ServiceId\\\\\\\\\\\\\\":126}]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 782,\\n \\"ServiceName\\": \\"xkc-crm\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"dubbo4\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"GroupName\\": \\"api\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"HttpDubboTranscoder\\": {\\n \\"DubboServiceName\\": \\"org.apache.dubbo.samples.basic.api.DemoService\\\\n\\",\\n \\"DubboServiceVersion\\": \\"0.0.0\\",\\n \\"MothedMapList\\": [\\n {\\n \\"DubboMothedName\\": \\"sayHello\\",\\n \\"HttpMothed\\": \\"ALL_GET\\",\\n \\"Mothedpath\\": \\"/mytestzbk/sayhello\\",\\n \\"PassThroughAllHeaders\\": \\"PASS_NOT\\",\\n \\"PassThroughList\\": [\\n \\"x-forward\\"\\n ],\\n \\"ParamMapsList\\": [\\n {\\n \\"ExtractKeySpec\\": \\"ALL_QUERY_PARAMETER\\",\\n \\"ExtractKey\\": \\"name\\",\\n \\"MappingType\\": \\"java.lang.String\\"\\n }\\n ]\\n }\\n ],\\n \\"DubboServiceGroup\\": \\"service group\\"\\n },\\n \\"ServicePort\\": 20880,\\n \\"HealthStatus\\": \\"Health\\",\\n \\"UnhealthyEndpoints\\": [\\n \\"192.168.1.2\\"\\n ]\\n }\\n ],\\n \\"HTTPRewrite\\": {\\n \\"Status\\": \\"off\\",\\n \\"Path\\": \\"/test/client\\",\\n \\"Host\\": \\"aliyuncs.com\\",\\n \\"PathType\\": \\"PRE\\",\\n \\"Pattern\\": \\"/test\\",\\n \\"Substitution\\": \\"test\\"\\n },\\n \\"HeaderOp\\": {\\n \\"Status\\": \\"off\\",\\n \\"HeaderOpItems\\": [\\n {\\n \\"DirectionType\\": \\"Response\\",\\n \\"OpType\\": \\"Add\\",\\n \\"Key\\": \\"debug\\",\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n },\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"{}\\"\\n },\\n \\"Cors\\": {\\n \\"Status\\": \\"off\\",\\n \\"AllowOrigins\\": \\"*\\",\\n \\"AllowMethods\\": \\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\n \\"AllowHeaders\\": \\"*\\",\\n \\"ExposeHeaders\\": \\"*\\",\\n \\"TimeUnit\\": \\"h\\",\\n \\"UnitNum\\": 24,\\n \\"AllowCredentials\\": true\\n },\\n \\"Timeout\\": {\\n \\"UnitNum\\": 10,\\n \\"TimeUnit\\": \\"s\\",\\n \\"Status\\": \\"off\\"\\n },\\n \\"Retry\\": {\\n \\"Attempts\\": 1,\\n \\"RetryOn\\": [\\n \\"5xx\\"\\n ],\\n \\"HttpCodes\\": [\\n \\"500\\"\\n ],\\n \\"Status\\": \\"on\\"\\n },\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"16\\",\\n \\"Path\\": \\"10111\\"\\n },\\n \\"FlowMirror\\": {\\n \\"TargetServiceId\\": 21,\\n \\"TargetServiceName\\": \\"test\\",\\n \\"Port\\": 8790,\\n \\"Percentage\\": 90,\\n \\"Status\\": \\"on\\"\\n },\\n \\"EnableWaf\\": true,\\n \\"AhasStatus\\": 1,\\n \\"Fallback\\": true,\\n \\"FallbackServices\\": [\\n {\\n \\"ServiceId\\": 1,\\n \\"ServiceName\\": \\"name\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"name\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"GroupName\\": \\"test\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"ServicePort\\": 8848\\n }\\n ],\\n \\"Policies\\": \\"{\\\\n \\\\\\"CORS\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"allowMethods\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"allowHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"exposeHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"unitNum\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"allowCredentials\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"allowOrigins\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Timeout\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"unitNum\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"timeUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"s\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Retry\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"attempts\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"retryOn\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"5xx\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"HTTPRewrite\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"pathType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EQUAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/o\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Waf\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\":false}\\\\\\",\\\\n \\\\\\"HeaderOp\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"headerOpItems\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"directionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Request\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"opType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Add\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kkk\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ll\\\\\\\\\\\\\\"}]}\\\\\\"\\\\n}\\",\\n \\"Description\\": \\"a route for xxx\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayRouteDetail', - ], - 'ListGatewayRoute' => [ - 'summary' => 'Queries the routes of a gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '25969', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'OrderItem', - 'in' => 'query', - 'schema' => [ - 'description' => 'The item based on which entries are sorted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreate', - ], - ], - [ - 'name' => 'DescSort', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable sorting. This parameter is unavailable.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'FilterParams', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The parameters that specify filter conditions. The parameters are in the format of {"key1":"value1"}.'."\n", - 'type' => 'object', - 'properties' => [ - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', - ], - 'Name' => [ - 'description' => 'The name of the gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'DefaultServiceId' => [ - 'description' => 'The default service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '默认服务ID（已废弃）', - 'deprecated' => true, - ], - 'RouteOrder' => [ - 'description' => 'The order.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'DomainId' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '284', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-30a0106924c94bca8712ec4e79fc5acc', - ], - 'DomainName' => [ - 'description' => 'The associated domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*.alites.com', - ], - 'Path' => [ - 'title' => '按路由路径模糊搜索', - 'type' => 'string', - 'example' => '/test', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '83F02EAB-ECDF-55C6-B332-8649E5E7AF2C', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => 'The code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => 'The data structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-cf0e7f52ecc7429dbc7ba4d5e3656100', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '496', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RouteOrder' => [ - 'description' => 'The order.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DefaultServiceName' => [ - 'description' => 'The default service name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DefaultServiceId' => [ - 'description' => 'The default service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Predicates' => [ - 'description' => 'The matching rules.'."\n", - 'type' => 'string', - 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/rpc/compute \\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":true}}', - ], - 'RoutePredicates' => [ - 'description' => 'The matching rules.'."\n", - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => 'The path used for route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The path of the node.'."\n", - 'type' => 'string', - 'example' => '/getIp', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => 'Indicates whether case sensitivity is ignored.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'MethodPredicates' => [ - 'description' => 'The HTTP methods used for route matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'HeaderPredicates' => [ - 'description' => 'The headers used for route matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The header list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The header key.'."\n", - 'type' => 'string', - 'example' => 'userid', - ], - 'Value' => [ - 'description' => 'The value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - 'QueryPredicates' => [ - 'description' => 'The parameters used for route matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key.'."\n", - 'type' => 'string', - 'example' => 'userid', - ], - 'Value' => [ - 'description' => 'The value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-25T07:14:01.817+0000', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'Services' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'RouteServices' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of services.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1563', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'hu', - ], - 'Percent' => [ - 'description' => 'The weight in the form of a percentage value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'api', - ], - 'AgreementType' => [ - 'description' => 'The type of the protocol.'."\n", - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'HttpDubboTranscoder' => [ - 'description' => 'The transcoder of the Dubbo protocol.'."\n", - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'The name of the Dubbo service.'."\n", - 'type' => 'string', - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', - ], - 'DubboServiceVersion' => [ - 'description' => 'The version of the Dubbo service.'."\n", - 'type' => 'string', - 'example' => '0.0.0', - ], - 'MothedMapList' => [ - 'description' => 'The forwarding rules of the Dubbo service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method mapping object.'."\n", - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'The method name of the Dubbo service.'."\n", - 'type' => 'string', - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'The HTTP method.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* ALL_GET'."\n" - ."\n" - .'* ALL_POST'."\n" - ."\n" - .'* ALL_PUT'."\n" - ."\n" - .'* ALL_DELETE'."\n" - ."\n" - .'* ALL_PATCH'."\n", - 'type' => 'string', - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => 'The path used for method matching.'."\n", - 'type' => 'string', - 'example' => '/mytestzbk/sayhello', - ], - 'PassThroughAllHeaders' => [ - 'description' => 'The pass-through type of the header.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* PASS_ALL: All headers are passed through.'."\n" - ."\n" - .'* PASS_NOT: All headers are not passed through.'."\n" - ."\n" - .'* PASS_ASSIGN: Specified headers are passed through.'."\n", - 'type' => 'string', - 'example' => 'PASS_NOT', - ], - 'PassThroughList' => [ - 'description' => 'The list of headers to be passed through.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the header to be passed through.'."\n", - 'type' => 'string', - 'example' => 'x-forward', - ], - ], - 'ParamMapsList' => [ - 'description' => 'The information about parameter mappings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter mapping object.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => 'The position of the input parameter.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* `ALL_QUERY_PARAMETER`: request parameter'."\n" - ."\n" - .'* `ALL_HEADER`: request header'."\n" - ."\n" - .'* `ALL_PATH`: request path'."\n" - ."\n" - .'* `ALL_BODY`: request body'."\n", - 'type' => 'string', - 'example' => 'ALL_QUERY_PARAMETER', - ], - 'ExtractKey' => [ - 'description' => 'The key extracted from the input parameter.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => 'The type of the backend service parameter.'."\n", - 'type' => 'string', - 'example' => 'java.lang.String', - ], - ], - ], - ], - ], - ], - ], - 'DubboServiceGroup' => [ - 'description' => 'The Dubbo service group.'."\n", - 'type' => 'string', - 'example' => 'service group', - ], - ], - ], - 'ServicePort' => [ - 'description' => 'The Dubbo port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20880', - ], - 'HealthStatus' => [ - 'title' => '健康状态'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Checking'."\n" - ."\n" - .'- Unknown', - 'type' => 'string', - 'example' => 'Health', - ], - 'UnhealthyEndpoints' => [ - 'title' => '非健康Endpoint列表', - 'type' => 'array', - 'items' => [ - 'title' => '非健康Endpoint', - 'type' => 'string', - 'example' => '192.168.1.2', - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '265', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'y.com', - ], - 'DestinationType' => [ - 'description' => 'The destination service type.'."\n", - 'type' => 'string', - 'example' => 'Single', - ], - 'DirectResponse' => [ - 'description' => 'The information about service mocking.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Body' => [ - 'description' => 'The return value for service mocking.'."\n", - 'type' => 'string', - 'example' => 'hello', - ], - ], - ], - 'DomainIdList' => [ - 'description' => 'The domain IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain IDs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - 'DomainNameList' => [ - 'description' => 'The domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain names.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - ], - 'Redirect' => [ - 'description' => 'The information about redirection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Host' => [ - 'description' => 'The hostname to be redirected to.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/test', - ], - ], - ], - 'Type' => [ - 'description' => 'The route type.'."\n", - 'type' => 'string', - 'example' => 'Op', - ], - 'Comment' => [ - 'description' => 'The route comment (ingress).'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'error', - ], - ], - ], - 'EnableWaf' => [ - 'description' => 'Indicates whether Web Application Firewall (WAF) is activated.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Fallback' => [ - 'description' => 'Indicates whether the Fallback service is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FallbackServices' => [ - 'description' => 'The information about the Fallback service.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '353'."\n", - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'service name', - ], - 'Percent' => [ - 'description' => 'The weight in the form of a percentage value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'example' => 'MSE'."\n", - ], - 'Namespace' => [ - 'description' => 'The namespace to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'Namespace', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => 'The type of the protocol.'."\n", - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'ServicePort' => [ - 'description' => 'The service port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8848', - ], - ], - ], - ], - 'DynamicRoute' => [ - 'title' => '是否开启动态路由', - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83F02EAB-ECDF-55C6-B332-8649E5E7AF2C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 36,\\n \\"PageNumber\\": 11,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 47,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-cf0e7f52ecc7429dbc7ba4d5e3656100\\",\\n \\"GatewayId\\": 496,\\n \\"Status\\": 2,\\n \\"RouteOrder\\": 1,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"DefaultServiceId\\": 1,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/rpc/compute \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":true}}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/getIp\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"GmtCreate\\": \\"2022-01-25T07:14:01.817+0000\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"Services\\": \\"[]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 1563,\\n \\"ServiceName\\": \\"hu\\",\\n \\"Percent\\": 11,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"test\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"api\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"HttpDubboTranscoder\\": {\\n \\"DubboServiceName\\": \\"org.apache.dubbo.samples.basic.api.DemoService\\",\\n \\"DubboServiceVersion\\": \\"0.0.0\\",\\n \\"MothedMapList\\": [\\n {\\n \\"DubboMothedName\\": \\"sayHello\\",\\n \\"HttpMothed\\": \\"ALL_GET\\",\\n \\"Mothedpath\\": \\"/mytestzbk/sayhello\\",\\n \\"PassThroughAllHeaders\\": \\"PASS_NOT\\",\\n \\"PassThroughList\\": [\\n \\"x-forward\\"\\n ],\\n \\"ParamMapsList\\": [\\n {\\n \\"ExtractKeySpec\\": \\"ALL_QUERY_PARAMETER\\",\\n \\"ExtractKey\\": \\"name\\",\\n \\"MappingType\\": \\"java.lang.String\\"\\n }\\n ]\\n }\\n ],\\n \\"DubboServiceGroup\\": \\"service group\\"\\n },\\n \\"ServicePort\\": 20880,\\n \\"HealthStatus\\": \\"Health\\",\\n \\"UnhealthyEndpoints\\": [\\n \\"192.168.1.2\\"\\n ]\\n }\\n ],\\n \\"DomainId\\": 265,\\n \\"DomainName\\": \\"y.com\\",\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"hello\\"\\n },\\n \\"DomainIdList\\": [\\n 123\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"test.com\\",\\n \\"Path\\": \\"/test\\"\\n },\\n \\"Type\\": \\"Op\\",\\n \\"Comment\\": {\\n \\"Status\\": \\"error\\"\\n },\\n \\"EnableWaf\\": \\"false\\",\\n \\"Fallback\\": true,\\n \\"FallbackServices\\": [\\n {\\n \\"ServiceId\\": 353,\\n \\"ServiceName\\": \\"service name\\",\\n \\"Percent\\": 100,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"name\\",\\n \\"SourceType\\": \\"MSE\\\\n\\",\\n \\"Namespace\\": \\"Namespace\\",\\n \\"GroupName\\": \\"test\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"ServicePort\\": 8848\\n }\\n ],\\n \\"DynamicRoute\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayRoute', - ], - 'UpdateGatewayRouteWafStatus' => [ - 'summary' => 'Updates the WAF status of a route.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '131361', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', - ], - ], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '645', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'EnableWaf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'GatewayId' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102', - ], - 'DefaultServiceId' => [ - 'description' => 'The default service ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DefaultServiceName' => [ - 'description' => 'The default service name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => 'The status of the route.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2022-01-26T09:52:41.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2022-02-24T06:08:29.230+0000', - ], - 'RouteOrder' => [ - 'description' => 'The sequence number of the route.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Predicates' => [ - 'description' => 'The matching rule.'."\n", - 'type' => 'string', - 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', - ], - 'RoutePredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => 'The information about route matching.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/zookeeper/mmgw/unlogined/common.getBu', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => 'Indicates whether case sensitivity is ignored.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'MethodPredicates' => [ - 'description' => 'The information about method matching.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'HeaderPredicates' => [ - 'description' => 'The information about matching based on request headers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request header.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the request header.'."\n", - 'type' => 'string', - 'example' => 'alibo', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Type' => [ - 'description' => 'The matching type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - 'QueryPredicates' => [ - 'description' => 'The parameter matching rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'nbhamster.com', - ], - 'Services' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'string', - 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', - ], - 'RouteServices' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about services.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '547', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'b-service', - ], - 'Percent' => [ - 'description' => 'The weight.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Version' => [ - 'description' => 'The version of the service.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test-aixue-gray', - ], - 'SourceType' => [ - 'description' => 'The source type of the service.'."\n", - 'type' => 'string', - 'example' => 'K8s', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the service belongs.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - ], - ], - ], - 'HTTPRewrite' => [ - 'description' => 'The information about the rewrite policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The HTTP status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'Path' => [ - 'description' => 'The HTTP request path.'."\n", - 'type' => 'string', - 'example' => '/test/client', - ], - 'Host' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'aliyuncs.com', - ], - 'PathType' => [ - 'description' => 'The path type of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'PRE', - ], - 'Pattern' => [ - 'description' => 'The matching pattern.'."\n", - 'type' => 'string', - 'example' => '/test', - ], - 'Substitution' => [ - 'description' => 'The replacement.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'HeaderOp' => [ - 'description' => 'The header settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'HeaderOpItems' => [ - 'description' => 'The policy.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'DirectionType' => [ - 'description' => 'The request or response.'."\n", - 'type' => 'string', - 'example' => 'Response', - ], - 'OpType' => [ - 'description' => 'The operation type.'."\n", - 'type' => 'string', - 'example' => 'Add', - ], - 'Key' => [ - 'description' => 'The header key.'."\n", - 'type' => 'string', - 'example' => 'debug', - ], - 'Value' => [ - 'description' => 'The header value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - 'DestinationType' => [ - 'description' => 'The destination service type.'."\n", - 'type' => 'string', - 'example' => 'Single', - ], - 'DirectResponse' => [ - 'description' => 'The information about service mocking.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The return value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Body' => [ - 'description' => 'The mock return value.'."\n", - 'type' => 'string', - 'example' => '[{\\"key\\":\\"h68d13466.sqa.eu95\\",\\"dims\\":\\"groupName=All}]', - ], - ], - ], - 'Cors' => [ - 'description' => 'The configuration for cross-origin resource sharing (CORS).'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'AllowOrigins' => [ - 'description' => 'The origins allowed.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'AllowMethods' => [ - 'description' => 'The methods allowed.'."\n", - 'type' => 'string', - 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', - ], - 'AllowHeaders' => [ - 'description' => 'The headers allowed.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'ExposeHeaders' => [ - 'description' => 'The response headers.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'TimeUnit' => [ - 'description' => 'The time unit.'."\n", - 'type' => 'string', - 'example' => 's', - ], - 'UnitNum' => [ - 'description' => 'The unit number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AllowCredentials' => [ - 'description' => 'The credentials allowed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Timeout' => [ - 'description' => 'The timeout configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'description' => 'The unit number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TimeUnit' => [ - 'description' => 'The time unit.'."\n", - 'type' => 'string', - 'example' => 's', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - ], - ], - 'Retry' => [ - 'description' => 'The retry configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Attempts' => [ - 'description' => 'The number of retries allowed for a request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RetryOn' => [ - 'description' => 'The retry condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retry condition.'."\n", - 'type' => 'string', - 'example' => '5xx', - ], - ], - 'HttpCodes' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '500', - ], - ], - 'Status' => [ - 'description' => 'The retry status.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - ], - ], - 'DomainIdList' => [ - 'description' => 'The list of domain IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of domain IDs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'DomainNameList' => [ - 'description' => 'The domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain names.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - ], - 'Redirect' => [ - 'description' => 'The configuration of the redirection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Host' => [ - 'description' => 'The hostname.'."\n", - 'type' => 'string', - 'example' => 'ww.al.c', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/', - ], - ], - ], - 'EnableWaf' => [ - 'description' => 'Indicates whether WAF is activated.'."\n", - 'type' => 'boolean', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 102,\\n \\"DefaultServiceId\\": 1,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2022-01-26T09:52:41.000+0000\\",\\n \\"GmtModified\\": \\"2022-02-24T06:08:29.230+0000\\",\\n \\"RouteOrder\\": 1,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/metas\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":false}}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/zookeeper/mmgw/unlogined/common.getBu\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"alibo\\",\\n \\"Value\\": \\"200\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"instanceId\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"nbhamster.com\\",\\n \\"Services\\": \\"[{\\\\\\\\\\\\\\"Percent\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"ServiceId\\\\\\\\\\\\\\":126}]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 547,\\n \\"ServiceName\\": \\"b-service\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"test-aixue-gray\\",\\n \\"SourceType\\": \\"K8s\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\"\\n }\\n ],\\n \\"HTTPRewrite\\": {\\n \\"Status\\": \\"off\\",\\n \\"Path\\": \\"/test/client\\",\\n \\"Host\\": \\"aliyuncs.com\\",\\n \\"PathType\\": \\"PRE\\",\\n \\"Pattern\\": \\"/test\\",\\n \\"Substitution\\": \\"test\\"\\n },\\n \\"HeaderOp\\": {\\n \\"Status\\": \\"off\\",\\n \\"HeaderOpItems\\": [\\n {\\n \\"DirectionType\\": \\"Response\\",\\n \\"OpType\\": \\"Add\\",\\n \\"Key\\": \\"debug\\",\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n },\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"[{\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h68d13466.sqa.eu95\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dims\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"groupName=All}]\\"\\n },\\n \\"Cors\\": {\\n \\"Status\\": \\"off\\",\\n \\"AllowOrigins\\": \\"*\\",\\n \\"AllowMethods\\": \\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\n \\"AllowHeaders\\": \\"*\\",\\n \\"ExposeHeaders\\": \\"*\\",\\n \\"TimeUnit\\": \\"s\\",\\n \\"UnitNum\\": 1,\\n \\"AllowCredentials\\": true\\n },\\n \\"Timeout\\": {\\n \\"UnitNum\\": 10,\\n \\"TimeUnit\\": \\"s\\",\\n \\"Status\\": \\"off\\"\\n },\\n \\"Retry\\": {\\n \\"Attempts\\": 1,\\n \\"RetryOn\\": [\\n \\"5xx\\"\\n ],\\n \\"HttpCodes\\": [\\n \\"500\\"\\n ],\\n \\"Status\\": \\"on\\"\\n },\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"ww.al.c\\",\\n \\"Path\\": \\"/\\"\\n },\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', - 'title' => 'UpdateGatewayRouteWafStatus', - ], - 'ApplyGatewayRoute' => [ - 'summary' => 'Publishes a route for a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '28369', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], - ], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '950', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1DB1AB36-8395-540E-AACC-7571D6B2057A', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data of the node.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DB1AB36-8395-540E-AACC-7571D6B2057A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'ApplyGatewayRoute', - ], - 'OfflineGatewayRoute' => [ - 'summary' => 'Disables a route for a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '645', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8EB24742-AB15-5953-BEFB-1FA18E770EEE', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'The request is successfully processed.'."\n", - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'Indicates whether the route is unpublished.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8EB24742-AB15-5953-BEFB-1FA18E770EEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'OfflineGatewayRoute', - ], - 'GetGatewayConfig' => [ - 'summary' => 'Obtains the parameter configurations of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '141101', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-61f465fa2dd044069e2208c4912*****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-61f465fa2dd044069e2208c4912*****', - ], - 'EnableGenerateRequestId' => [ - 'title' => '是否生成requestId', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableGzip' => [ - 'title' => '是否启用gzip进行压缩', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EnableSlashMerge' => [ - 'title' => '是否合并‘/’, 开启后www.a.com//b多余的\'/\'会被合并，将会同www.a.com/b一致', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DownstreamIdleTime' => [ - 'title' => '客户端到网关处于指定的时间内[0-600]没有请求，则会断开链接', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '180', - ], - 'PreserveHeaderFormat' => [ - 'title' => '是否保持header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DownstreamConnectionBufferLimits' => [ - 'title' => '单条链接的buffer大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32768', - ], - 'EnableHardwareAccelerate' => [ - 'title' => '是否开启硬件加速(若您的地域处于底层不支持地域，或购买时未指定硬件加速会生效失败)', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'XffTrustedNum' => [ - 'title' => '网关前可信任的设备个数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EnableHttp2' => [ - 'title' => '是否默认开启http2', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DownstreamHttp2MaxConcurrentStream' => [ - 'title' => '下游http最大并发数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'InitialStreamWindowSize' => [ - 'title' => 'http2 stream 初始窗口大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '65535', - ], - 'InitialConnectionWindowSize' => [ - 'title' => 'http2 连接 初始窗口大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1048576', - ], - 'XtraceDetails' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TraceOn' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '255', - ], - 'Sample' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-61f465fa2dd044069e2208c4912*****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-08-12T09:39:07.000+0000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-08-12T09:39:07.000+0000', - ], - 'TraceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OPENTELEMETRY', - ], - 'ServiceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '333', - ], - 'ServicePort' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8888', - ], - ], - ], - 'SlsConfigDetails' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LogOn' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'LogStoreName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mse_gw_access_log', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-61f465fa2dd044069e2208c4912*****'."\n", - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' ""', - ], - 'NginxCompatible' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'SupportWaf' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableWaf' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessLogHeader' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}', - ], - 'EnableHttp3' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UpstreamIdleTimeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'ZipAlgorithm' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["gzip"]', - ], - 'PathWithEscapedSlashes' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'KEEP_UNCHANGED', - ], - 'NoSupportedConfigList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"EnableProxyProtocol,EnableCustomAuthConfigPush"', - ], - 'LogFilterConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' ""', - ], - 'EnableProxyProtocol' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableCustomAuthConfigPush' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'KeepaliveHeaderTimeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WebsocketTermGracePeriod' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'EnableK8sSourceWorkloadFilter' => [ - 'type' => 'object', - 'properties' => [ - 'Enable' => [ - 'type' => 'boolean', - ], - 'LabelKey' => [ - 'type' => 'string', - ], - 'LabelValue' => [ - 'type' => 'string', - ], - 'FilterOpt' => [ - 'type' => 'string', - ], - ], - ], - 'EnableXffTrustedCidrs' => [ - 'type' => 'object', - 'properties' => [ - 'Enable' => [ - 'type' => 'boolean', - ], - 'IpListContent' => [ - 'type' => 'string', - ], - ], - ], - 'EnableGzipHardwareAccelerate' => [ - 'type' => 'boolean', - ], - 'PreserveExternalRequestID' => [ - 'type' => 'boolean', - ], - 'LiteMetrics' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6092602-C357-4750-89D9-E572FBEA****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\",\\n \\"EnableGenerateRequestId\\": true,\\n \\"EnableGzip\\": false,\\n \\"EnableSlashMerge\\": true,\\n \\"DownstreamIdleTime\\": 180,\\n \\"PreserveHeaderFormat\\": true,\\n \\"DownstreamConnectionBufferLimits\\": 32768,\\n \\"EnableHardwareAccelerate\\": true,\\n \\"XffTrustedNum\\": 0,\\n \\"EnableHttp2\\": false,\\n \\"DownstreamHttp2MaxConcurrentStream\\": 100,\\n \\"InitialStreamWindowSize\\": 65535,\\n \\"InitialConnectionWindowSize\\": 1048576,\\n \\"XtraceDetails\\": {\\n \\"TraceOn\\": true,\\n \\"Id\\": 255,\\n \\"Sample\\": 100,\\n \\"GatewayId\\": 500,\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\",\\n \\"GmtCreate\\": \\"2024-08-12T09:39:07.000+0000\\",\\n \\"GmtModified\\": \\"2024-08-12T09:39:07.000+0000\\",\\n \\"TraceType\\": \\"OPENTELEMETRY\\",\\n \\"ServiceId\\": 333,\\n \\"ServicePort\\": \\"8888\\"\\n },\\n \\"SlsConfigDetails\\": {\\n \\"LogOn\\": true,\\n \\"Id\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"LogStoreName\\": \\"mse_gw_access_log\\",\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\\\n\\",\\n \\"GatewayId\\": 500,\\n \\"GmtCreate\\": \\"\\\\\\"\\\\\\"\\",\\n \\"GmtModified\\": \\" \\\\\\"\\\\\\"\\",\\n \\"NginxCompatible\\": false\\n },\\n \\"SupportWaf\\": true,\\n \\"EnableWaf\\": true,\\n \\"AccessLogHeader\\": \\"{\\\\\\"requestMetadata\\\\\\":[],\\\\\\"responseHeaders\\\\\\":[],\\\\\\"requestHeaders\\\\\\":[\\\\\\"x-test\\\\\\"],\\\\\\"responseMetadata\\\\\\":[]}\\",\\n \\"EnableHttp3\\": false,\\n \\"UpstreamIdleTimeout\\": 30,\\n \\"ZipAlgorithm\\": \\"[\\\\\\"gzip\\\\\\"]\\",\\n \\"PathWithEscapedSlashes\\": \\"KEEP_UNCHANGED\\",\\n \\"NoSupportedConfigList\\": \\"\\\\\\"EnableProxyProtocol,EnableCustomAuthConfigPush\\\\\\"\\",\\n \\"LogFilterConfig\\": \\" \\\\\\"\\\\\\"\\",\\n \\"EnableProxyProtocol\\": true,\\n \\"EnableCustomAuthConfigPush\\": \\"false\\",\\n \\"KeepaliveHeaderTimeout\\": 0,\\n \\"WebsocketTermGracePeriod\\": 30,\\n \\"EnableK8sSourceWorkloadFilter\\": {\\n \\"Enable\\": true,\\n \\"LabelKey\\": \\"\\",\\n \\"LabelValue\\": \\"\\",\\n \\"FilterOpt\\": \\"\\"\\n },\\n \\"EnableXffTrustedCidrs\\": {\\n \\"Enable\\": true,\\n \\"IpListContent\\": \\"\\"\\n },\\n \\"EnableGzipHardwareAccelerate\\": true,\\n \\"PreserveExternalRequestID\\": true,\\n \\"LiteMetrics\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetGatewayConfig', - ], - 'EnableProxyProtocol' => [ - 'summary' => 'Enables the proxy protocol. When an NLB instance is used as an ingress, you cannot obtain the real IP address of the client if you do not enable the proxy protocol. After you enable the proxy protocol, non-proxy requests are not adversely affected.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], - ], - [ - 'name' => 'EnableProxyProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false** (default)'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult\\'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> For example, if the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the **DtsJobId** parameter in the request is invalid.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'EnableProxyProtocol', - ], - 'EnableHttp2' => [ - 'summary' => 'Enables HTTP/2 for negotiation between the server and client. The modification takes effect in one to two minutes.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '142072', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', - ], - ], - [ - 'name' => 'EnableHttp2', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable HTTP/2 for negotiation between the server and client. This parameter applies to requests. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> The request parameter **DtsJobId** is invalid if **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'Indicates whether HTTP/2 is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'EnableHttp2', - ], - 'PreserveHeaderFormat' => [ - 'summary' => 'Specifies whether to convert all letters of a header into lowercase letters. For requests and responses, HTTP/1.1 headers are not case-sensitive. By default, all letters of headers are converted into lowercase letters.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '142071', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], - ], - [ - 'name' => 'PreserveHeaderFormat', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the request header is case-sensitive. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => 'The dynamic part in the error message.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" - ."\n" - .'> The request parameter **DtsJobId** is invalid if **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'PreserveHeaderFormat', - ], - 'CreateGatewayFlowRule' => [ - 'summary' => 'Creates a throttling rule for a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the gateway.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the route.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '52853', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the routing rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], - ], - [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The overall queries per second (QPS) threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the web fallback behavior.'."\n" - ."\n" - .'0: returns the specified content.'."\n" - ."\n" - .'1: redirects to the specified page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => 'The encoding format.'."\n" - ."\n" - .'0: normal text'."\n" - ."\n" - .'1: JSON'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP text to be returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'ResponseRedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'The address to be redirected to.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the throttling rule.'."\n" - ."\n" - .'0: disables the throttling rule.'."\n" - ."\n" - .'1: enables the throttling rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****', - ], - 'Data' => [ - 'description' => 'The ID of the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '608', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72FC625E-9629-591B-9C01-3F0BFDAB****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', - 'title' => 'CreateGatewayFlowRule', - ], - 'DeleteGatewayFlowRule' => [ - 'summary' => 'Deletes a throttling rule for a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11151', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteGatewayFlowRule', - ], - 'UpdateGatewayFlowRule' => [ - 'summary' => 'Queries throttling rules of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '549', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '48811', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'routeA', - ], - ], - [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'ResponseRedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48811', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeA', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"StatDurationMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"Text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 549\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'UpdateGatewayFlowRule', - ], - 'ListGatewayFlowRule' => [ - 'summary' => 'Queries throttling rules of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'FilterParams', - 'in' => 'query', - 'schema' => [ - 'title' => 'just for POP', - 'description' => 'just for POP', - 'type' => 'string', - 'required' => true, - 'example' => 'param', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0951EBF0-798E-5E0B-8D38-460A14AD****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48811', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeA', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - 'Results' => [ - 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48811', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeA', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0951EBF0-798E-5E0B-8D38-460A14AD****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"Enable\\": 0\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"StatDurationMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 549\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayFlowRule', - ], - 'CreateGatewayCircuitBreakerRule' => [ - 'summary' => 'Creates a gateway circuit breaking rule.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '645', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], - ], - [ - 'name' => 'Strategy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'TriggerRatio', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'StatDurationSec', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '11', - ], - ], - [ - 'name' => 'RecoveryTimeoutSec', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], - ], - [ - 'name' => 'MinRequestAmount', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'MaxAllowedMs', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'ResponseRedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": 28\\n}","type":"json"}]', - 'title' => 'CreateGatewayCircuitBreakerRule', - ], - 'DeleteGatewayCircuitBreakerRule' => [ - 'summary' => 'Deletes a gateway circuit breaking rule.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11151', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteGatewayCircuitBreakerRule', - ], - 'UpdateGatewayCircuitBreakerRule' => [ - 'summary' => 'Updates a gateway circuit breaking rule.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '369', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '645', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], - ], - [ - 'name' => 'Strategy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'TriggerRatio', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'StatDurationSec', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '11', - ], - ], - [ - 'name' => 'RecoveryTimeoutSec', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], - ], - [ - 'name' => 'MinRequestAmount', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'MaxAllowedMs', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'ResponseRedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '369', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '645', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeName', - ], - 'Strategy' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TriggerRatio' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationSec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'RecoveryTimeoutSec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'MinRequestAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxAllowedMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '201', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '369', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Id\\": 369,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-c9bc5afd61014165bd58f621b491****\\",\\n \\"RouteId\\": 645,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 201,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 369\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'UpdateGatewayCircuitBreakerRule', - ], - 'ListGatewayCircuitBreakerRule' => [ - 'summary' => 'Queries a gateway circuit breaking rule.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'FilterParams', - 'in' => 'query', - 'schema' => [ - 'title' => 'just for POP', - 'description' => 'just for POP', - 'type' => 'string', - 'required' => true, - 'example' => 'param', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11919', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3091', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeName', - ], - 'Strategy' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TriggerRatio' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationSec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'RecoveryTimeoutSec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'MinRequestAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxAllowedMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '14', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - ], - ], - ], - ], - 'Results' => [ - 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11919', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-1ee34548c68f4778a25c05abd657****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3450', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeName', - ], - 'Strategy' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TriggerRatio' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationSec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'RecoveryTimeoutSec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'MinRequestAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxAllowedMs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 11,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 467,\\n \\"GatewayId\\": 11919,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"RouteId\\": 3091,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 14,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 204,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 467\\n ]\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 467,\\n \\"GatewayId\\": 11919,\\n \\"GatewayUniqueId\\": \\"gw-1ee34548c68f4778a25c05abd657****\\",\\n \\"RouteId\\": 3450,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 204,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 467\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayCircuitBreakerRule', - ], - 'CreateGatewayIsolationRule' => [ - 'summary' => 'Creates a concurrency rule for a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '52853', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], - ], - [ - 'name' => 'MaxConcurrency', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'ResponseRedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '608', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', - 'title' => 'CreateGatewayIsolationRule', - ], - 'DeleteGatewayIsolationRule' => [ - 'summary' => 'Deletes the gateway concurrency rule.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11151', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteGatewayIsolationRule', - ], - 'UpdateGatewayIsolationRule' => [ - 'summary' => 'Updates the concurrency rule of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '358', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '52853', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], - ], - [ - 'name' => 'MaxConcurrency', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'ResponseRedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52853', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeName', - ], - 'MaxConcurrency' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'UpdateGatewayIsolationRule', - ], - 'ListGatewayIsolationRule' => [ - 'summary' => 'Queries the concurrency rule of a gateway.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'FilterParams', - 'in' => 'query', - 'schema' => [ - 'title' => 'just for POP', - 'description' => 'just for POP', - 'type' => 'string', - 'required' => true, - 'example' => 'param', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F025D43-8632-5716-AE9B-7EDDF16C****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52853', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeName', - ], - 'MaxConcurrency' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key:value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - ], - ], - ], - ], - 'Results' => [ - 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - 'GatewayId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52853', - ], - 'RouteName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'routeName', - ], - 'MaxConcurrency' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LimitMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BehaviorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F025D43-8632-5716-AE9B-7EDDF16C****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key:value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 1,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListGatewayIsolationRule', - ], - 'InitializeServiceLinkRole' => [ - 'summary' => 'Creates a Microservices Engine (MSE) service-linked role.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'common', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17049', - 'abilityTreeNodes' => [ - 'FEATUREmseRIJL6U', - ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'Token', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - ], - [ - 'name' => 'RoleName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AliyunServiceRoleForMSE', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RoleName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AliyunServiceRoleForMSE', - ], - 'RequiredPermission' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ram:CreateServiceLinkedRole', - ], - 'ServiceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mse.aliyuncs.com', - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX\\",\\n \\"Data\\": {\\n \\"RoleName\\": \\"AliyunServiceRoleForMSE\\",\\n \\"RequiredPermission\\": \\"ram:CreateServiceLinkedRole\\",\\n \\"ServiceName\\": \\"mse.aliyuncs.com\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'InitializeServiceLinkRole', - ], - 'CloneSentinelRuleFromAhas' => [ - 'summary' => 'Clones rules from Application High Availability Service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '209225', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', - ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间', - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'MseAppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MSE application after migration. If this parameter is not specified, the name of the Application High Availability Service (AHAS) application is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', - ], - ], - [ - 'name' => 'AhasNamespace', - 'in' => 'query', - 'schema' => [ - 'title' => 'AHAS侧命名空间（环境）。', - 'description' => 'The namespace (environment) of Application High Availability Service (AHAS).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'IsAHASPublicRegion', - 'in' => 'query', - 'schema' => [ - 'title' => 'AHAS侧是否为公网地域。', - 'description' => 'Specifies whether AHAS is deployed in the Internet region.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>>', - 'description' => 'RestResult\\>'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Data' => [ - 'title' => '返回结果。', - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '执行结果。', - 'description' => 'The execution result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => '"Finish AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b ..."'."\n", - 'description' => 'The execution result details.'."\n", - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Data\\": {\\n \\"key\\": [\\n \\"\\\\\\"完成 AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b 应用的流控规则迁移。AHAS 侧总规则数: 14 ；成功迁移的规则数: 7 ；完成迁移但存在异常的规则数: 2 ；迁移失败的规则数: 5\\\\\\"\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'CloneSentinelRuleFromAhas', - ], - 'ChangeResourceGroup' => [ - 'summary' => 'Resource Transfer', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'common', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '150111', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], - ], - 'parameters' => [ - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'Resource type, such as a registration and configuration center cluster or gateway instance', - 'type' => 'string', - 'required' => false, - 'example' => 'Cluster,Gateway', - 'default' => 'Cluster', - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源Id', - 'description' => 'Resource ID, which is the ID of the registration and configuration center instance or the unique ID of the gateway', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-xxxxxxxxxxx，'."\n" - .'gw-xxxxxxxxxxxxxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceRegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域Id', - 'description' => 'Region ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '目标资源组', - 'description' => 'Target resource group', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfm34x43l*****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => 'The language in which the response is displayed. Values: zh (default): Chinese, en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListNacosMcpServers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListNacosMcpServers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response Schema', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - ], + [ + 'apiName' => 'ListEurekaServices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NoPermission.ChangeResourceGroup', - 'errorMessage' => 'You are not authorized to change resourcegroup', - ], - [ - 'errorCode' => 'MissingParameter.ResourceRegionId', - 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', - ], - [ - 'errorCode' => 'MissingParameter.ResourceId', - 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', - ], - [ - 'errorCode' => 'MissingParameter.ResourceGroupId', - 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', - ], - [ - 'errorCode' => 'InvalidResourceGroup', - 'errorMessage' => 'The specified ResourceGroupId is invalid', + [ + 'apiName' => 'QueryInstancesInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryInstancesInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred while processing your request', + ], + ], + [ + 'apiName' => 'GetAppMessageQueueRoute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetAppMessageQueueRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => ' The specified resource is not found', + ], + ], + [ + 'apiName' => 'CreateGatewayIsolationRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + ], + ], + [ + 'apiName' => 'ListZnodeChildren', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZnodeChildren', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'AddMigrationTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'AddAuthResource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddAuthResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'ListConfigTrack', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListConfigTrack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'DeleteGateway', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGateway', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\"\\n}","type":"json"}]', - 'title' => 'Change the Resource Group of an Instance', - 'translator' => 'machine', - ], - 'UpdateNacosGrayConfig' => [ - 'summary' => 'Updates the canary release settings, which include beta release and tag-based canary release.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'AddGatewayRoute', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListGateway', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'CloneNacosConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryAllSwimmingLaneGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateNacosConfig', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215876', - 'abilityTreeNodes' => [ - 'FEATUREmseK09GZC', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mse_prepaid_public_cn-st2212****', + [ + 'apiName' => 'GetNacosMcpServer', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosMcpServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间ID，默认为public', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', + ], + [ + 'apiName' => 'CreateOrUpdateSwimmingLaneGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateOrUpdateSwimmingLaneGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], ], ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'title' => '配置分组，默认为DEFAULT_GROUP', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', + ], + [ + 'apiName' => 'ApplyGatewayRoute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ApplyGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'title' => '配置dataId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + ], + [ + 'apiName' => 'ListGatewayDomain', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'title' => '配置内容', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asdf', + ], + [ + 'apiName' => 'ListClusters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GrayType', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度类型，支持Beta灰度(根据IP灰度)和标签灰度', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Tags', - 'enum' => [ - 'Beta', - 'Tags', - ], + ], + [ + 'apiName' => 'CreateEngineNamespace', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GrayRule', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'key=value1,value2', + ], + [ + 'apiName' => 'DeleteGatewayCircuitBreakerRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StopGray', - 'in' => 'query', - 'schema' => [ - 'title' => '是否停止灰度', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + ], + [ + 'apiName' => 'CreateMseServiceApplication', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateMseServiceApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'ExportZookeeperData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ExportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - 'title' => '参数弃用，无需填写', + ], + [ + 'apiName' => 'AddSSLCert', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddSSLCert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', + ], + [ + 'apiName' => 'UpdateMessageQueueRoute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateMessageQueueRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GrayRuleName', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度版本名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + ], + [ + 'apiName' => 'DeleteGatewayService', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'GrayRulePriority', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度版本优先级', - 'type' => 'integer', - 'format' => 'int32', + ], + [ + 'apiName' => 'UpdateGatewayRouteWafStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteWafStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'OpType', - 'in' => 'query', - 'schema' => [ - 'title' => '操作类型，Create（创建新的灰度配置），Update（更新存在的灰度配置）', - 'type' => 'string', + ], + [ + 'apiName' => 'GetGovernanceKubernetesCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'RestartCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:RestartCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Data' => [ - 'title' => '是否更新成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'GetApplicationInstanceList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationInstanceList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Nacos.Intercepted', - 'errorMessage' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry.', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + [ + 'apiName' => 'ListGatewayAuth', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayAuth', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListGatewayRouteOnAuth', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRouteOnAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'DeleteNacosService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'UpdateZooKeeperSaslUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateNacosGrayConfig', - ], - 'UpdateGatewayConfig' => [ - 'summary' => 'Updates gateway configurations.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'gateway', + [ + 'apiName' => 'AddZooKeeperSaslUser', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteMigrationTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '261694', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', + [ + 'apiName' => 'DeleteWebFlowRules', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-b525dc1adf3c486ab96224a6346*****', + [ + 'apiName' => 'GetServiceListeners', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceListeners', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], ], - [ - 'name' => 'ConfigName', - 'in' => 'query', - 'schema' => [ - 'title' => '参数配置名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'EnableK8sSourceWorkloadFilter', + ], + [ + 'apiName' => 'CreateNacosInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ConfigValue', - 'in' => 'query', - 'schema' => [ - 'title' => '参数配置值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"enable":true,"filterOpt":"EQUAL","labelKey":"key","labelValue":"value"}', + ], + [ + 'apiName' => 'GetNacosHistoryConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosHistoryConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListWebFlowRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', - ], - ], + [ + 'apiName' => 'CreateCircuitBreakerRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'CreateNacosMcpServer', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateNacosMcpServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'UpdateNacosGrayConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListNacosConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'CreateIsolationRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'PutClusterHealthCheckTask', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:PutClusterHealthCheckTask', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GatewayBlackWhiteList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GatewayBlackWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\"\\n}","type":"json"}]', - 'title' => 'UpdateGatewayConfig', - ], - 'CreateSentinelBlockFallbackDefinition' => [ - 'summary' => '创建行为管理', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListTagResources', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryAllSwimmingLane', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], + ], ], - 'tags' => [ - 'msc', + [ + 'apiName' => 'CreateNacosConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListApplicationsWithTagRules', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListApplicationsWithTagRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateZnode', + 'description' => '', 'operationType' => 'update', - 'abilityTreeCode' => '163988', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', + 'ramAction' => [ + 'action' => 'mse:UpdateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-app', + [ + 'apiName' => 'UpdateBlackWhiteList', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'UpdateGatewayServiceCheck', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceCheck', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'edasmsc', + ], + [ + 'apiName' => 'QueryGovernanceKubernetesCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'JAVA', + ], + [ + 'apiName' => 'GetMseFeatureSwitch', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseFeatureSwitch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DeletePluginConfig', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeletePluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abcde@12345', + ], + [ + 'apiName' => 'UpdateAcl', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateAcl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Scenario', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', + ], + [ + 'apiName' => 'QueryNacosGrayConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceClassification', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1 Web'."\n" - .'2 Rpc', + ], + [ + 'apiName' => 'DeleteNacosConfigs', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FallbackBehavior', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"webFallbackMode":0,"webRespMessage":"{}","webRespStatusCode":429,"webRespContentType":0}', + ], + [ + 'apiName' => 'AddGatewayAuth', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MyFallback', + ], + [ + 'apiName' => 'ListGatewaySlb', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListAnsInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceClassification' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34726', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'FallbackBehavior' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}', - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - ], + ], + [ + 'apiName' => 'UpdateGatewayServiceVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'ListNamespaces', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListNamespaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'RemoveZooKeeperSaslUser', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListGatewayCircuitBreakerRule', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'ListAnsServiceClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsServiceClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": {\\n \\"ResourceClassification\\": 1,\\n \\"UserId\\": \\"123456\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Id\\": 34726,\\n \\"Namespace\\": \\"default\\",\\n \\"Name\\": \\"test\\",\\n \\"FallbackBehavior\\": \\"{\\\\\\"webRespStatusCode\\\\\\":429,\\\\\\"webRespMessage\\\\\\":\\\\\\"test\\\\\\",\\\\\\"webFallbackMode\\\\\\":0,\\\\\\"webRespContentType\\\\\\":0}\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - ], - 'CreateNacosMcpServer' => [ - 'summary' => '创建一个MCP Server', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'QueryClusterSpecification', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:QueryClusterSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetGatewayAuthDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayAuthDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'ListExportZookeeperData', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListExportZookeeperData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateGatewayFlowRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateZnode', + 'description' => '', 'operationType' => 'create', - 'abilityTreeCode' => '273078', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + 'ramAction' => [ + 'action' => 'mse:CreateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'public', + [ + 'apiName' => 'OfflineGatewayRoute', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:OfflineGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'ServerSpecification', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Server描述的JSON字符串', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"description":"a mcp demo service","capabilities":[],"allVersions":[{"version":"1.0.0","release_date":"2025-08-13T01:58:42Z","is_latest":true}],"remoteServerConfig":{"exportPath":"/sse"},"enabled":true,"versionDetail":{"version":"1.0.1"},"backendEndpoints":[{"path":"/sse","address":"127.0.0.1","port":8080}],"protocol":"mcp-sse","name":"mcp-demo","frontProtocol":"mcp-sse"}', + ], + [ + 'apiName' => 'GetEngineNamepace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetEngineNamepace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ToolSpecification', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Tool的描述的JSON字符串', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"tools":[{"name":"demo-tool","description":"a demo tool","inputSchema":{"type":"object","properties":{"name":{"type":"string","description":"name"}}}}],"toolsMeta":{"demo-tool":{"enabled":true}}}', + ], + [ + 'apiName' => 'ListAppBySwimmingLaneGroupTags', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndpointSpecification', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Endpoint描述的Json字符串', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"type":"REF","data":{"namespaceId":"public","groupName":"mcp-endpoints","serviceName":"mcp-demo"}}', + ], + [ + 'apiName' => 'ListGatewayAuthConsumer', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', + ], + [ + 'apiName' => 'GetBlackWhiteList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'ServerName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mcp-demo', + ], + [ + 'apiName' => 'ListEngineNamespaces', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListEngineNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'YamlConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'allowTools:'."\n" - .'- demo-tool'."\n" - .'securityScheme: {}'."\n" - .'server:'."\n" - .' name: mcp-demo'."\n" - .'tools:'."\n" - .'- args:'."\n" - .' - name: name'."\n" - .' description: name'."\n" - .' type: string'."\n" - .' description: a demo tool'."\n" - .' name: demo-tool'."\n", + ], + [ + 'apiName' => 'UpdateImage', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateImage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], - [ - 'name' => 'EncryptToolSpec', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', + ], + [ + 'apiName' => 'CreatePluginConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreatePluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListSecurityGroupRule', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'UpdateGatewayAuthConsumer', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Resource.exist', - 'errorMessage' => 'Resource %s already exists, cannot be created repeatedly.', + [ + 'apiName' => 'DeleteAuthResource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteAuthResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - [ - 'errorCode' => 'Nacos.Intercepted', - 'errorMessage' => 'The request is blocked by the security barrier detection. Check the request content and modify the retry.', + ], + ], + [ + 'apiName' => 'QuerySlbSpec', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:QuerySlbSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + ], + ], + [ + 'apiName' => 'QueryNamespace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'ListMigrationTask', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ImportZookeeperData', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ImportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'ModifyGovernanceKubernetesCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ModifyGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'GetPluginConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetPluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListNamingTrack', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNamingTrack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - ], - 'DeleteNacosMcpServer' => [ - 'summary' => '删除一个MCP Server', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListGatewayZone', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BindSentinelBlockFallbackDefinition', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:BindSentinelBlockFallbackDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceApplication', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}/application/{#AppName}'], + ], + ], + ], + [ + 'apiName' => 'GetGatewayConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListServiceSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'QueryConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetGatewayDomainDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayDomainDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListGatewayService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'GetZookeeperDataImportUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetZookeeperDataImportUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OrderClusterHealthCheckRiskNotice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:OrderClusterHealthCheckRiskNotice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAnsServices', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteGatewaySlb', + 'description' => '', 'operationType' => 'delete', - 'abilityTreeCode' => '273079', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', + [ + 'apiName' => 'DeleteGatewayAuth', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fc0f6e40-****-946b-45e3af313707', + ], + [ + 'apiName' => 'ListSecurityGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSecurityGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'McpServerId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + [ + 'apiName' => 'UpdateNacosService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'DeleteNacosInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'GetServiceListPage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceListPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'ListAuthPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'RetryCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:RetryCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'CreateApplication', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'UpdateGatewayRouteRetry', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteRetry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'QueryGatewayRegion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayRegion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ApplyTagPolicies', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ApplyTagPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"Data\\": true\\n}","type":"json"}]', - ], - 'GetNacosMcpServer' => [ - 'summary' => '获取MCP Server的详情', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'GetGatewayOption', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayOption', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateGatewayCircuitBreakerRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'UpdateGatewayRouteHeaderOp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteHeaderOp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ImportNacosConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateGatewayRouteCORS', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteCORS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewaySpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewaySpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'GetImage', + 'description' => '', 'operationType' => 'get', - 'abilityTreeCode' => '273076', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + 'ramAction' => [ + 'action' => 'mse:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl327w****', + [ + 'apiName' => 'DeleteGatewayServiceVersion', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayServiceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + [ + 'apiName' => 'AddBlackWhiteList', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'McpServerId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + [ + 'apiName' => 'PullServices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:PullServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'McpServerVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', + ], + [ + 'apiName' => 'CreateCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'GetGateway', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGateway', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RemoteServerConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceRef' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NamespaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'ServiceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mcp-service', - ], - ], - ], - 'ExportPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/sse', - ], - ], - ], - 'LocalServerConfig' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => '', - ], - ], - 'BackendEndpoints' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Path' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/sse', - ], - ], - ], - ], - 'ToolSpec' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Tools' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'get_weather', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a weather query tool', - ], - 'InputSchema' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '{"type":"object","properties":{"name":{"type":"string","description":"name"}}}', - 'description' => '', - ], - ], - ], - ], - ], - 'ToolsMeta' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'type' => 'boolean', - 'example' => 'true', - 'description' => '', - ], - 'Templates' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => '{"requestTemplate":{"url":"https://api.example.com/endpoint/{{.args.NewArg1}}","method":"GET","headers":[{"key":"Authorization","value":"Bearer {{.security.token}}"}]},"responseTemplate":{"body":"{{.}}"},"argsPosition":{"NewArg1":"path"}}', - ], - 'description' => '', - ], - ], - 'description' => '', - ], - ], - 'SpecificationType' => [ - 'type' => 'string', - ], - 'SecuritySchemes' => [ - 'type' => 'any', - ], - 'ToolDecryptStatus' => [ - 'type' => 'string', - ], - ], - ], - 'AllVersions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0.9', - ], - 'Release_date' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-07-16'."\n", - ], - 'Is_latest' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'ID。', - 'type' => 'string', - 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mcp-demo', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mcp-sse', - ], - 'FrontProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mcp-sse', - ], - 'Capabilities' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TOOL', - ], - ], - 'VersionDetail' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.11.0', - ], - 'ReleaseDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-07-16', - ], - 'IsLatest' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'YamlConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'allowTools:'."\n" - .'- demo-tool'."\n" - .'securityScheme: {}'."\n" - .'server:'."\n" - .' name: mcp-demo'."\n" - .'tools:'."\n" - .'- args:'."\n" - .' - name: name'."\n" - .' description: name'."\n" - .' type: string'."\n" - .' description: a demo tool'."\n" - .' name: demo-tool'."\n", - ], - ], - ], - ], + [ + 'apiName' => 'DeleteFlowRules', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryClusterDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayFlowRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLocalityRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateLocalityRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'CreateNamespace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'QueryClusterDiskSpecification', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDiskSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'UpdateGatewayRouteHTTPRewrite', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteHTTPRewrite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'RemoveAuthPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:RemoveAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'UpdateGatewayCircuitBreakerRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'AddGatewayServiceVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayServiceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72FC625E-9629-591B-9C01-3F0BFDAB****\\",\\n \\"Data\\": {\\n \\"RemoteServerConfig\\": {\\n \\"ServiceRef\\": {\\n \\"NamespaceId\\": \\"public\\",\\n \\"GroupName\\": \\"DEFAULT\\",\\n \\"ServiceName\\": \\"mcp-service\\"\\n },\\n \\"ExportPath\\": \\"/sse\\"\\n },\\n \\"LocalServerConfig\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"mcpServers\\\\\\":\\\\n {\\\\n \\\\\\"amap-mcp-server\\\\\\":\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"高德地图服务\\\\\\",\\\\n \\\\\\"command\\\\\\": \\\\\\"npx\\\\\\",\\\\n \\\\\\"args\\\\\\":\\\\n [\\\\n \\\\\\"-y\\\\\\",\\\\n \\\\\\"@amap/amap-maps-mcp-server\\\\\\"\\\\n ],\\\\n \\\\\\"env\\\\\\":\\\\n {\\\\n \\\\\\"AMAP_MAPS_API_KEY\\\\\\": \\\\\\"\\\\\\"\\\\n }\\\\n }\\\\n }\\\\n}\\\\n\\"\\n },\\n \\"BackendEndpoints\\": [\\n {\\n \\"Address\\": \\"127.0.0.1\\",\\n \\"Port\\": 80,\\n \\"Path\\": \\"/sse\\"\\n }\\n ],\\n \\"ToolSpec\\": {\\n \\"Tools\\": [\\n {\\n \\"Name\\": \\"get_weather\\",\\n \\"Description\\": \\"a weather query tool\\",\\n \\"InputSchema\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\":\\\\\\"object\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"name\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"string\\\\\\",\\\\\\"description\\\\\\":\\\\\\"name\\\\\\"}}}\\"\\n }\\n }\\n ],\\n \\"ToolsMeta\\": {\\n \\"key\\": {\\n \\"Enabled\\": true,\\n \\"Templates\\": {\\n \\"key\\": \\"{\\\\\\"requestTemplate\\\\\\":{\\\\\\"url\\\\\\":\\\\\\"https://api.example.com/endpoint/{{.args.NewArg1}}\\\\\\",\\\\\\"method\\\\\\":\\\\\\"GET\\\\\\",\\\\\\"headers\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"Authorization\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Bearer {{.security.token}}\\\\\\"}]},\\\\\\"responseTemplate\\\\\\":{\\\\\\"body\\\\\\":\\\\\\"{{.}}\\\\\\"},\\\\\\"argsPosition\\\\\\":{\\\\\\"NewArg1\\\\\\":\\\\\\"path\\\\\\"}}\\"\\n }\\n }\\n },\\n \\"SpecificationType\\": \\"\\",\\n \\"SecuritySchemes\\": \\"\\",\\n \\"ToolDecryptStatus\\": \\"\\"\\n },\\n \\"AllVersions\\": [\\n {\\n \\"Version\\": \\"1.0.9\\",\\n \\"Release_date\\": \\"2025-07-16\\\\n\\",\\n \\"Is_latest\\": true\\n }\\n ],\\n \\"Enabled\\": true,\\n \\"Id\\": \\"5e3c5211-d365-4013-8540-c4106ec2a5dc\\",\\n \\"Name\\": \\"mcp-demo\\",\\n \\"Description\\": \\"描述\\",\\n \\"Protocol\\": \\"mcp-sse\\",\\n \\"FrontProtocol\\": \\"mcp-sse\\",\\n \\"Capabilities\\": [\\n \\"TOOL\\"\\n ],\\n \\"VersionDetail\\": {\\n \\"Version\\": \\"1.11.0\\",\\n \\"ReleaseDate\\": \\"2025-07-16\\",\\n \\"IsLatest\\": true\\n },\\n \\"YamlConfig\\": \\"allowTools:\\\\n- demo-tool\\\\nsecurityScheme: {}\\\\nserver:\\\\n name: mcp-demo\\\\ntools:\\\\n- args:\\\\n - name: name\\\\n description: name\\\\n type: string\\\\n description: a demo tool\\\\n name: demo-tool\\\\n\\"\\n }\\n}","type":"json"}]', - ], - 'ListNacosMcpServers' => [ - 'summary' => '获取McpServer列表', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'UpdateGatewayService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteNamespace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteNacosMcpServer', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosMcpServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'SelectGatewaySlb', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:SelectGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'AddServiceSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'AddGatewayAuthConsumer', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayAuthConsumer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpgradeCluster', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpgradeCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExportNacosConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ExportNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#AccountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayOption', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayOption', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'ListSentinelBlockFallbackDefinitions', + 'description' => '', 'operationType' => 'list', - 'abilityTreeCode' => '273080', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + 'ramAction' => [ + 'action' => 'mse:ListSentinelBlockFallbackDefinitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', + [ + 'apiName' => 'DeleteGatewayFlowRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + [ + 'apiName' => 'CreateNacosService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Search', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'blur', + ], + [ + 'apiName' => 'UpdateGatewayAuth', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'EnableProxyProtocol', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:EnableProxyProtocol', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'DeleteCircuitBreakerRules', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'UpdatePluginConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdatePluginConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListListenersByIp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListListenersByIp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'PageNumber' => [ - 'title' => 'pageNumber.', - 'description' => 'pageNumber.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PagesAvailable' => [ - 'title' => 'pagesAvailable.', - 'description' => 'pagesAvailable.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageItems' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'string', - 'example' => '2385420b-6176-4a37-aba4-d3d382e4bb84', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test ', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stdio', - ], - 'FrontProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mcp-sse', - ], - 'Capabilities' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TOOL', - ], - ], - 'VersionDetail' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'Release_date' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-07-16', - ], - 'Is_latest' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.0', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListEurekaInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'UpdateEngineNamespace', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'UpdateFlowRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListFlowRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'ListListenersByConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListListenersByConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'AddMockRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:AddMockRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteGatewayAuthConsumer', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 4,\\n \\"PageNumber\\": 1,\\n \\"PagesAvailable\\": 1,\\n \\"PageItems\\": [\\n {\\n \\"Id\\": \\"2385420b-6176-4a37-aba4-d3d382e4bb84\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test \\",\\n \\"Protocol\\": \\"stdio\\",\\n \\"FrontProtocol\\": \\"mcp-sse\\",\\n \\"Capabilities\\": [\\n \\"TOOL\\"\\n ],\\n \\"VersionDetail\\": {\\n \\"Version\\": \\"1.0.0\\",\\n \\"Release_date\\": \\"2025-07-16\\",\\n \\"Is_latest\\": true\\n },\\n \\"Version\\": \\"1.1.0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'QueryNacosGrayConfig' => [ - 'summary' => 'Queries canary configurations of a Nacos instance.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'UpdateGatewayIsolationRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateWebFlowRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'ListCircuitBreakerRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteSwimmingLaneGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetApplicationList', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '216072', - 'abilityTreeNodes' => [ - 'FEATUREmseK09GZC', + 'ramAction' => [ + 'action' => 'mse:GetApplicationList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-st21ri2****', + [ + 'apiName' => 'ListNacosHistoryConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosHistoryConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6bafdde3-4fa7-4d67-b3da-a607ab87f7e4', + ], + [ + 'apiName' => 'CreateSentinelBlockFallbackDefinition', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateSentinelBlockFallbackDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'title' => '配置分组', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', + ], + [ + 'apiName' => 'UpdateGatewayAuthConsumerStatus', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumerStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'title' => '配置dataId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'demo-develop', + ], + [ + 'apiName' => 'UpdateServiceSource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DeleteServiceSource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteServiceSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + ], + [ + 'apiName' => 'ListClusterVersions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GrayName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'ListGatewayRoute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'GetLosslessRuleByApp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLosslessRuleByApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GrayType' => [ - 'title' => '灰度类型，Beta或者Tag', - 'description' => '', - 'type' => 'string', - 'example' => 'Tags', - ], - 'GrayRule' => [ - 'title' => '灰度规则', - 'description' => '', - 'type' => 'string', - 'example' => 'nacos.config.gray.label=test', - ], - 'Group' => [ - 'title' => '配置分组', - 'description' => '', - 'type' => 'string', - 'example' => 'dubbo', - ], - 'DataId' => [ - 'title' => '配置dataId', - 'description' => '', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Content' => [ - 'title' => '配置内容', - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'Md5' => [ - 'title' => '配置内容md5', - 'description' => '', - 'type' => 'string', - 'example' => '87d14faf58a103ac8840b9c5f1c2a0fe', - ], - 'LastModified' => [ - 'title' => '配置最后修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '1742277568000', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'GrayRuleName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Beta(IP)', - ], - 'GrayRulePriority' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], + [ + 'apiName' => 'DeleteGatewayIsolationRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'GetServiceMethodPage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceMethodPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'GetGatewayAuthConsumerDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayAuthConsumerDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'UpdateWebFlowRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'UpdateGatewayServiceTrafficPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceTrafficPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'AddSecurityGroupRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateNacosCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Data\\": {\\n \\"GrayType\\": \\"Tags\\",\\n \\"GrayRule\\": \\"nacos.config.gray.label=test\\",\\n \\"Group\\": \\"dubbo\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Content\\": \\"text\\",\\n \\"Md5\\": \\"87d14faf58a103ac8840b9c5f1c2a0fe\\",\\n \\"LastModified\\": \\"1742277568000\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"GrayRuleName\\": \\"Beta(IP)\\",\\n \\"GrayRulePriority\\": \\"100\\"\\n }\\n}","type":"json"}]', - 'title' => 'QueryNacosGrayConfig', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'mse.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'mse.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-jva', - 'endpoint' => 'mse.cn-zhengzhou-jva.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'mse.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wuhan-lr', - 'endpoint' => 'mse.cn-wuhan-lr.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'mse.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'mse.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'mse.cn-heyuan.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'mse.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'mse.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'mse.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'mse.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'mse.cn-fuzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'mse.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'mse.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'mse.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'mse.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'mse.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'mse.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'mse.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'mse.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'mse.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'mse.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'mse.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'mse.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'mse.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'mse.me-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'mse.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'mse.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'mse.cn-shenzhen-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'mse.cn-beijing-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'mse.cn-shanghai-finance-1.aliyuncs.com', + [ + 'apiName' => 'UpdateClusterSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateClusterSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddGatewayDomain', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyLosslessRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ModifyLosslessRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetGatewayServiceDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGatewayServiceDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'EnableHttp2', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:EnableHttp2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'ListZooKeeperSaslUser', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InitializeServiceLinkRole', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:InitializeServiceLinkRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PreserveHeaderFormat', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:PreserveHeaderFormat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'RemoveApplication', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayAuthConsumerResourceStatus', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayAuthConsumerResourceStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'GetPlugins', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetPlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'CreateOrUpdateSwimmingLane', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateOrUpdateSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], + ], + ], + [ + 'apiName' => 'GetKubernetesSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetKubernetesSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteZnode', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFlowRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClusterConnectionTypes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterConnectionTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateCircuitBreakerRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAuthPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ['validationType' => 'always', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ['validationType' => 'always', 'resourceType' => 'NacosConfig', 'arn' => 'acs:mse:*:{#accountId}:nacosconfig/{#DataId}'], + ['validationType' => 'always', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#Region}:{#AccountId}:instance/{#GatewayUniqueId}'], + ['validationType' => 'always', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ['validationType' => 'always', 'resourceType' => 'NacosService', 'arn' => 'acs:mse:*:{#accountId}:nacosservice/{#ServiceName}'], + ['validationType' => 'always', 'resourceType' => 'NacosInstance', 'arn' => 'acs:mse:{#regionId}:{#accountId}:nacosinstance/*'], + ['validationType' => 'always', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/*'], + ['validationType' => 'always', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:cluster/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'GovernanceApplication', 'arn' => 'acs:mse:{#Region}:{#AccountId}:namespace/{#Namespace}/application/{#AppName}'], + ['validationType' => 'always', 'resourceType' => 'NacosConfig', 'arn' => 'acs:mse::{#accountId}:nacosconfig/{#DataId}'], + ['validationType' => 'always', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/*'], + ['validationType' => 'always', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/*'], + ['validationType' => 'always', 'resourceType' => 'GovernanceApplication', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}/application/{#AppName}'], + ['validationType' => 'always', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#Region}:{#AccountId}:namespace/{#Namespace}'], ], ], ]; -- cgit v1.2.3